rtc.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_RTC_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_RTC_H_
 
/* **** Includes **** */
#include <stdint.h>
#include "mxc_device.h"
#include "rtc_regs.h"
#include "mxc_sys.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MXC_RTC_MAX_SSEC (MXC_F_RTC_SSEC_SSEC + 1)
#define MXC_RTC_TRIM_TMR_IRQ \
    0x0 //Place holder to prevent build errors, RevA function which uses this will never be called
 
/* **** Definitions **** */
typedef enum {
    MXC_RTC_F_1HZ = MXC_S_RTC_CTRL_SQW_SEL_FREQ1HZ, 
    MXC_RTC_F_512HZ = MXC_S_RTC_CTRL_SQW_SEL_FREQ512HZ, 
    MXC_RTC_F_4KHZ = MXC_S_RTC_CTRL_SQW_SEL_FREQ4KHZ, 
    MXC_RTC_F_32KHZ = 32, 
} mxc_rtc_freq_sel_t;
 
typedef enum {
    MXC_RTC_INT_EN_LONG = MXC_F_RTC_CTRL_TOD_ALARM_IE, 
    MXC_RTC_INT_EN_SHORT =
        MXC_F_RTC_CTRL_SSEC_ALARM_IE, 
    MXC_RTC_INT_EN_READY = MXC_F_RTC_CTRL_RDY_IE, 
} mxc_rtc_int_en_t;
 
typedef enum {
    MXC_RTC_INT_FL_LONG = MXC_F_RTC_CTRL_TOD_ALARM, 
    MXC_RTC_INT_FL_SHORT = MXC_F_RTC_CTRL_SSEC_ALARM, 
    MXC_RTC_INT_FL_READY = MXC_F_RTC_CTRL_RDY, 
} mxc_rtc_int_fl_t;
 
int MXC_RTC_SetTimeofdayAlarm(uint32_t ras);
 
int MXC_RTC_SetSubsecondAlarm(uint32_t rssa);
 
int MXC_RTC_Start(void);
int MXC_RTC_Stop(void);
 
int MXC_RTC_Init(uint32_t sec, uint16_t ssec);
 
int MXC_RTC_SquareWaveStart(mxc_rtc_freq_sel_t fq);
 
int MXC_RTC_SquareWaveStop(void);
 
int MXC_RTC_Trim(int8_t trm);
 
int MXC_RTC_EnableInt(uint32_t mask);
 
int MXC_RTC_DisableInt(uint32_t mask);
 
int MXC_RTC_GetFlags(void);
 
int MXC_RTC_ClearFlags(int flags);
 
#ifdef __GNUC__
__attribute__((deprecated("Use MXC_RTC_GetSubSeconds() instead.")))
#endif
int MXC_RTC_GetSubSecond(void);
 
int MXC_RTC_GetSubSeconds(uint32_t *ssec);
 
#ifdef __GNUC__
__attribute__((deprecated("Use MXC_RTC_GetSeconds() instead.")))
#endif
int MXC_RTC_GetSecond(void);
 
int MXC_RTC_GetSeconds(uint32_t *sec);
 
int MXC_RTC_GetTime(uint32_t *sec, uint32_t *subsec);
 
int MXC_RTC_GetBusyFlag(void);
 
int MXC_RTC_TrimCrystal(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_RTC_H_