mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/rtc.c@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 186:707f6e361f3e 1 /**
Anna Bridge 186:707f6e361f3e 2 * @file
Anna Bridge 186:707f6e361f3e 3 * @brief Real-Time Clock Function Implementations.
Anna Bridge 186:707f6e361f3e 4 */
Anna Bridge 186:707f6e361f3e 5 /* ****************************************************************************
Anna Bridge 186:707f6e361f3e 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 186:707f6e361f3e 7 *
Anna Bridge 186:707f6e361f3e 8 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 186:707f6e361f3e 9 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 186:707f6e361f3e 10 * to deal in the Software without restriction, including without limitation
Anna Bridge 186:707f6e361f3e 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 186:707f6e361f3e 12 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 186:707f6e361f3e 13 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 186:707f6e361f3e 14 *
Anna Bridge 186:707f6e361f3e 15 * The above copyright notice and this permission notice shall be included
Anna Bridge 186:707f6e361f3e 16 * in all copies or substantial portions of the Software.
Anna Bridge 186:707f6e361f3e 17 *
Anna Bridge 186:707f6e361f3e 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 186:707f6e361f3e 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 186:707f6e361f3e 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 186:707f6e361f3e 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 186:707f6e361f3e 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 186:707f6e361f3e 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 186:707f6e361f3e 24 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 186:707f6e361f3e 25 *
Anna Bridge 186:707f6e361f3e 26 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 186:707f6e361f3e 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 186:707f6e361f3e 28 * Products, Inc. Branding Policy.
Anna Bridge 186:707f6e361f3e 29 *
Anna Bridge 186:707f6e361f3e 30 * The mere transfer of this software does not imply any licenses
Anna Bridge 186:707f6e361f3e 31 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 186:707f6e361f3e 32 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 186:707f6e361f3e 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 186:707f6e361f3e 34 * ownership rights.
Anna Bridge 186:707f6e361f3e 35 *
Anna Bridge 186:707f6e361f3e 36 * $Date: 2016-09-08 17:43:13 -0500 (Thu, 08 Sep 2016) $
Anna Bridge 186:707f6e361f3e 37 * $Revision: 24326 $
Anna Bridge 186:707f6e361f3e 38 *
Anna Bridge 186:707f6e361f3e 39 **************************************************************************** */
Anna Bridge 186:707f6e361f3e 40
Anna Bridge 186:707f6e361f3e 41 /* **** Includes **** */
Anna Bridge 186:707f6e361f3e 42 #include <string.h>
Anna Bridge 186:707f6e361f3e 43
Anna Bridge 186:707f6e361f3e 44 #include "rtc.h"
Anna Bridge 186:707f6e361f3e 45 #include "mxc_assert.h"
Anna Bridge 186:707f6e361f3e 46 #include "mxc_sys.h"
Anna Bridge 186:707f6e361f3e 47
Anna Bridge 186:707f6e361f3e 48 /**
Anna Bridge 186:707f6e361f3e 49 * @ingroup rtc
Anna Bridge 186:707f6e361f3e 50 * @{
Anna Bridge 186:707f6e361f3e 51 */
Anna Bridge 186:707f6e361f3e 52 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 53 int RTC_Init(const rtc_cfg_t *cfg)
Anna Bridge 186:707f6e361f3e 54 {
Anna Bridge 186:707f6e361f3e 55 int err;
Anna Bridge 186:707f6e361f3e 56 int i = 0;
Anna Bridge 186:707f6e361f3e 57
Anna Bridge 186:707f6e361f3e 58 //init function -> validate configuration pointer is not NULL
Anna Bridge 186:707f6e361f3e 59 if (cfg == NULL)
Anna Bridge 186:707f6e361f3e 60 return E_NULL_PTR;
Anna Bridge 186:707f6e361f3e 61 //check to make sure that the passed in parameters, prescaler mask and snooze, are valid
Anna Bridge 186:707f6e361f3e 62 if ((cfg->prescalerMask > ((rtc_prescale_t)cfg->prescaler)) || (cfg->snoozeCount > MXC_F_RTC_SNZ_VAL_VALUE))
Anna Bridge 186:707f6e361f3e 63 return E_INVALID;
Anna Bridge 186:707f6e361f3e 64
Anna Bridge 186:707f6e361f3e 65 // Set system level configurations
Anna Bridge 186:707f6e361f3e 66 if ((err = SYS_RTC_Init()) != E_NO_ERROR) {
Anna Bridge 186:707f6e361f3e 67 return err;
Anna Bridge 186:707f6e361f3e 68 }
Anna Bridge 186:707f6e361f3e 69
Anna Bridge 186:707f6e361f3e 70 //disable rtc
Anna Bridge 186:707f6e361f3e 71 MXC_RTCTMR->ctrl &= ~(MXC_F_RTC_CTRL_ENABLE);
Anna Bridge 186:707f6e361f3e 72
Anna Bridge 186:707f6e361f3e 73 //disable all interrupts
Anna Bridge 186:707f6e361f3e 74 MXC_RTCTMR->inten = 0;
Anna Bridge 186:707f6e361f3e 75
Anna Bridge 186:707f6e361f3e 76 //clear all interrupts
Anna Bridge 186:707f6e361f3e 77 MXC_RTCTMR->flags = RTC_FLAGS_CLEAR_ALL;
Anna Bridge 186:707f6e361f3e 78
Anna Bridge 186:707f6e361f3e 79 //reset starting count
Anna Bridge 186:707f6e361f3e 80 MXC_RTCTMR->timer = 0;
Anna Bridge 186:707f6e361f3e 81
Anna Bridge 186:707f6e361f3e 82 //set the compare registers to the values passed in
Anna Bridge 186:707f6e361f3e 83 for(i = 0; i < RTC_NUM_COMPARE; i++)
Anna Bridge 186:707f6e361f3e 84 MXC_RTCTMR->comp[i] = cfg->compareCount[i];
Anna Bridge 186:707f6e361f3e 85
Anna Bridge 186:707f6e361f3e 86 // set the prescaler
Anna Bridge 186:707f6e361f3e 87 MXC_RTCTMR->prescale = cfg->prescaler;
Anna Bridge 186:707f6e361f3e 88 // set the prescale mask, checked it for validity on entry
Anna Bridge 186:707f6e361f3e 89 MXC_RTCTMR->prescale_mask = cfg->prescalerMask;
Anna Bridge 186:707f6e361f3e 90
Anna Bridge 186:707f6e361f3e 91 //set snooze mode (rtc_snooze_t)
Anna Bridge 186:707f6e361f3e 92 MXC_RTCTMR->ctrl &= (~MXC_F_RTC_CTRL_SNOOZE_ENABLE);
Anna Bridge 186:707f6e361f3e 93 MXC_RTCTMR->ctrl |= (cfg->snoozeMode << MXC_F_RTC_CTRL_SNOOZE_ENABLE_POS);
Anna Bridge 186:707f6e361f3e 94
Anna Bridge 186:707f6e361f3e 95 //set the snooze count. Checked for validity on entry.
Anna Bridge 186:707f6e361f3e 96 MXC_RTCTMR->snz_val = (cfg->snoozeCount << MXC_F_RTC_SNZ_VAL_VALUE_POS) & MXC_F_RTC_SNZ_VAL_VALUE;
Anna Bridge 186:707f6e361f3e 97
Anna Bridge 186:707f6e361f3e 98 //wait for pending actions to complete
Anna Bridge 186:707f6e361f3e 99 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
Anna Bridge 186:707f6e361f3e 100
Anna Bridge 186:707f6e361f3e 101 //reset trim to defaults, trim disabled, trim faster override disabled
Anna Bridge 186:707f6e361f3e 102 MXC_RTCTMR->trim_ctrl &= ~(MXC_F_RTC_TRIM_CTRL_TRIM_ENABLE_R | MXC_F_RTC_TRIM_CTRL_TRIM_FASTER_OVR_R);
Anna Bridge 186:707f6e361f3e 103
Anna Bridge 186:707f6e361f3e 104 //set trim slower control bit to 0, which is trim faster by default
Anna Bridge 186:707f6e361f3e 105 MXC_RTCTMR->trim_value &= ~(MXC_F_RTC_TRIM_VALUE_TRIM_SLOWER_CONTROL);
Anna Bridge 186:707f6e361f3e 106
Anna Bridge 186:707f6e361f3e 107 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 108 }
Anna Bridge 186:707f6e361f3e 109
Anna Bridge 186:707f6e361f3e 110 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 111 int RTC_SetCompare(uint8_t compareIndex, uint32_t counts)
Anna Bridge 186:707f6e361f3e 112 {
Anna Bridge 186:707f6e361f3e 113 //check for invalid index
Anna Bridge 186:707f6e361f3e 114 if (compareIndex >= RTC_NUM_COMPARE)
Anna Bridge 186:707f6e361f3e 115 return E_INVALID;
Anna Bridge 186:707f6e361f3e 116
Anna Bridge 186:707f6e361f3e 117 MXC_RTCTMR->comp[compareIndex] = counts;
Anna Bridge 186:707f6e361f3e 118
Anna Bridge 186:707f6e361f3e 119 //wait for pending actions to complete
Anna Bridge 186:707f6e361f3e 120 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
Anna Bridge 186:707f6e361f3e 121
Anna Bridge 186:707f6e361f3e 122 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 123 }
Anna Bridge 186:707f6e361f3e 124
Anna Bridge 186:707f6e361f3e 125 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 126 uint32_t RTC_GetCompare(uint8_t compareIndex)
Anna Bridge 186:707f6e361f3e 127 {
Anna Bridge 186:707f6e361f3e 128 //Debug Assert for Invalid Index
Anna Bridge 186:707f6e361f3e 129 MXC_ASSERT(compareIndex < RTC_NUM_COMPARE);
Anna Bridge 186:707f6e361f3e 130 //check for invalid index
Anna Bridge 186:707f6e361f3e 131 if (compareIndex >= RTC_NUM_COMPARE)
Anna Bridge 186:707f6e361f3e 132 return (uint32_t)(E_BAD_PARAM); /* Unsigned int, so if out of bounds we return 0xFFFFFFFD (-3) */
Anna Bridge 186:707f6e361f3e 133
Anna Bridge 186:707f6e361f3e 134 return MXC_RTCTMR->comp[compareIndex];
Anna Bridge 186:707f6e361f3e 135 }
Anna Bridge 186:707f6e361f3e 136
Anna Bridge 186:707f6e361f3e 137 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 138 int RTC_SetTrim(uint32_t trim, uint8_t trimSlow)
Anna Bridge 186:707f6e361f3e 139 {
Anna Bridge 186:707f6e361f3e 140 // make sure rtc is disabled
Anna Bridge 186:707f6e361f3e 141 if(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_ENABLE)
Anna Bridge 186:707f6e361f3e 142 return E_BAD_STATE; // RTC is active, bad state
Anna Bridge 186:707f6e361f3e 143
Anna Bridge 186:707f6e361f3e 144 // Can check against this because it starts at bit 0 in the register
Anna Bridge 186:707f6e361f3e 145 // Need to check because too large of a value messes with the upper bits in
Anna Bridge 186:707f6e361f3e 146 // the trim register.
Anna Bridge 186:707f6e361f3e 147 if (trim > MXC_F_RTC_TRIM_VALUE_TRIM_VALUE)
Anna Bridge 186:707f6e361f3e 148 return E_INVALID;
Anna Bridge 186:707f6e361f3e 149
Anna Bridge 186:707f6e361f3e 150 // write the trim to the hardware trim_value register
Anna Bridge 186:707f6e361f3e 151 MXC_RTCTMR->trim_value = (trim << MXC_F_RTC_TRIM_VALUE_TRIM_VALUE_POS) & MXC_F_RTC_TRIM_VALUE_TRIM_VALUE;
Anna Bridge 186:707f6e361f3e 152
Anna Bridge 186:707f6e361f3e 153 if(trimSlow)
Anna Bridge 186:707f6e361f3e 154 MXC_RTCTMR->trim_value |= MXC_F_RTC_TRIM_VALUE_TRIM_SLOWER_CONTROL;
Anna Bridge 186:707f6e361f3e 155 else
Anna Bridge 186:707f6e361f3e 156 MXC_RTCTMR->trim_value &= ~MXC_F_RTC_TRIM_VALUE_TRIM_SLOWER_CONTROL;
Anna Bridge 186:707f6e361f3e 157
Anna Bridge 186:707f6e361f3e 158 //wait for pending actions to complete
Anna Bridge 186:707f6e361f3e 159 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
Anna Bridge 186:707f6e361f3e 160
Anna Bridge 186:707f6e361f3e 161 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 162 }
Anna Bridge 186:707f6e361f3e 163
Anna Bridge 186:707f6e361f3e 164 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 165 uint32_t RTC_GetTrim()
Anna Bridge 186:707f6e361f3e 166 {
Anna Bridge 186:707f6e361f3e 167 return MXC_RTCTMR->trim_value; // return the register value for trim
Anna Bridge 186:707f6e361f3e 168 }
Anna Bridge 186:707f6e361f3e 169
Anna Bridge 186:707f6e361f3e 170 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 171 int RTC_TrimEnable(void)
Anna Bridge 186:707f6e361f3e 172 {
Anna Bridge 186:707f6e361f3e 173 // make sure rtc is disabled
Anna Bridge 186:707f6e361f3e 174 if(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_ENABLE)
Anna Bridge 186:707f6e361f3e 175 return E_BAD_STATE; // RTC is active, bad state
Anna Bridge 186:707f6e361f3e 176
Anna Bridge 186:707f6e361f3e 177 MXC_RTCTMR->trim_ctrl = MXC_F_RTC_TRIM_CTRL_TRIM_ENABLE_R;
Anna Bridge 186:707f6e361f3e 178
Anna Bridge 186:707f6e361f3e 179 //wait for pending actions to complete
Anna Bridge 186:707f6e361f3e 180 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
Anna Bridge 186:707f6e361f3e 181
Anna Bridge 186:707f6e361f3e 182 return E_NO_ERROR;
Anna Bridge 186:707f6e361f3e 183 }
Anna Bridge 186:707f6e361f3e 184
Anna Bridge 186:707f6e361f3e 185 /* ************************************************************************* */
Anna Bridge 186:707f6e361f3e 186 void RTC_TrimDisable(void)
Anna Bridge 186:707f6e361f3e 187 {
Anna Bridge 186:707f6e361f3e 188 // clear the trim enable bit
Anna Bridge 186:707f6e361f3e 189 MXC_RTCTMR->trim_ctrl &= ~MXC_F_RTC_TRIM_CTRL_TRIM_ENABLE_R;
Anna Bridge 186:707f6e361f3e 190
Anna Bridge 186:707f6e361f3e 191 //wait for pending actions to complete
Anna Bridge 186:707f6e361f3e 192 while(MXC_RTCTMR->ctrl & MXC_F_RTC_CTRL_PENDING);
Anna Bridge 186:707f6e361f3e 193
Anna Bridge 186:707f6e361f3e 194 return;
Anna Bridge 186:707f6e361f3e 195 }
Anna Bridge 186:707f6e361f3e 196
Anna Bridge 186:707f6e361f3e 197 /**@} end of ingroup rtc*/