mirror of
https://github.com/joeycastillo/second-movement.git
synced 2026-02-04 06:25:32 +00:00
99 lines
3.2 KiB
C
99 lines
3.2 KiB
C
////< @file rtc32.h
|
|
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2020 Joey Castillo
|
|
* Copyright (c) 2025 Alessandro Genova
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
/**
|
|
* @addtogroup rtc Real-Time Clock
|
|
* @brief Functions for configuring and using the Real-Time Clock peripheral.
|
|
* @details This is the rtc implementation for MODE0 (counter32)
|
|
* @{
|
|
*/
|
|
|
|
#define RTC_REFERENCE_YEAR (2020)
|
|
|
|
typedef union {
|
|
struct {
|
|
uint32_t second : 6; // 0-59
|
|
uint32_t minute : 6; // 0-59
|
|
uint32_t hour : 5; // 0-23
|
|
uint32_t day : 5; // 1-31
|
|
uint32_t month : 4; // 1-12
|
|
uint32_t year : 6; // 0-63 (representing 2020-2083)
|
|
} unit;
|
|
uint32_t reg; // the bit-packed value as expected by the RTC peripheral's CLOCK register.
|
|
} rtc_date_time_t;
|
|
|
|
typedef enum rtc_alarm_match_t {
|
|
ALARM_MATCH_DISABLED = 0,
|
|
ALARM_MATCH_SS,
|
|
ALARM_MATCH_MMSS,
|
|
ALARM_MATCH_HHMMSS,
|
|
} rtc_alarm_match_t;
|
|
|
|
typedef uint32_t rtc_counter_t;
|
|
|
|
typedef void (*rtc_cb_t)(uint16_t intflag);
|
|
|
|
/** @brief Initializes the RTC.
|
|
* @details Configures the RTC for COUNT32 mode, with a 1 Hz
|
|
* tick derived from the 1024 Hz clock on GCLK3 (for SAM D devices)
|
|
* or OSC32KCTRL's most accurate 1024 Hz output (for SAM L devices).
|
|
*/
|
|
void rtc_init(void);
|
|
|
|
/** @brief Enables the RTC.
|
|
*/
|
|
void rtc_enable(void);
|
|
|
|
/** @brief Checks if the RTC is enabled.
|
|
* @return true if the RTC is enabled; false if not.
|
|
*/
|
|
bool rtc_is_enabled(void);
|
|
|
|
/** @brief Set the value of the counter register.
|
|
*/
|
|
void rtc_set_counter(rtc_counter_t counter);
|
|
|
|
/** @brief Returns the value of the counter register.
|
|
*/
|
|
rtc_counter_t rtc_get_counter(void);
|
|
|
|
/** @brief Configures the RTC alarm callback.
|
|
* @param callback The function to call when an RTC interrupt occurs. The callback
|
|
* will be passed a bitmask of the interrupt flags, the full contents
|
|
* of the RTC peripheral's INTFLAG register.
|
|
*/
|
|
void rtc_configure_callback(rtc_cb_t callback);
|
|
|
|
void rtc_enable_compare_interrupt(uint32_t compare_time);
|
|
void rtc_disable_compare_interrupt(void);
|
|
|
|
/** @} */
|