Files
2026-09-18 10:50:36 +10:00

114 lines
3.5 KiB
C

/*
* Copyright (C) EdgeTX
*
* Based on code named
* opentx - https://github.com/opentx/opentx
* th9x - http://code.google.com/p/th9x
* er9x - http://code.google.com/p/er9x
* gruvin9x - http://code.google.com/p/gruvin9x
*
* License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#pragma once
#include <inttypes.h>
#define SECS_PER_HOUR 3600ul
#define SECS_PER_DAY 86400ul
#define TM_YEAR_BASE 1900
#define TIME_T_MIN (-LONG_MAX)
#define TIME_T_MAX (LONG_MAX)
#define SET_LOAD_DATETIME(x) { rtcSetTime(x); g_rtcTime = gmktime(x); }
typedef long int gtime_t;
struct gtm
{
int8_t tm_sec; /* Seconds. [0-60] (1 leap second) */
int8_t tm_min; /* Minutes. [0-59] */
int8_t tm_hour; /* Hours. [0-23] */
int8_t tm_mday; /* Day. [1-31] */
int8_t tm_mon; /* Month. [0-11] */
uint8_t tm_year; /* Year - 1900. Limited to the year 2155. */
int8_t tm_wday; /* Day of week. [0-6] */
int16_t tm_yday; /* Day of year. [0-365] Needed internally for calculations */
};
extern gtime_t g_rtcTime;
extern uint8_t g_ms100; // global to allow time set function to reset to zero
bool rtcIsValid();
void rtcInit();
void rtcSetTime(const struct gtm * tm);
// Host timed the second boundary itself, ms is how far into it the true time was
void rtcSetTimeAt(const struct gtm * tm, uint16_t ms);
gtime_t gmktime (struct gtm *tm);
uint8_t rtcAdjust(uint16_t year, uint8_t mon, uint8_t day, uint8_t hour, uint8_t min, uint8_t sec);
// Driver interface, rtcSetTime() wraps rtcDriverSetTime()
void rtcDriverSetTime(const struct gtm * tm);
void rtcGetTime(struct gtm * tm);
uint16_t rtcGetTimeMs(struct gtm * tm); // fills tm, returns 0..999 within that second
// Smooth calibration, one unit is one clock pulse out of 2^20 (~0.954 ppm)
#define RTC_CALIB_UNITS_PER_SECOND 1048576
#define RTC_CALIB_UNIT_MAX 512
#define RTC_CALIB_UNIT_MIN (-511)
int32_t rtcGetCalibration();
void rtcSetCalibration(int32_t units);
int32_t rtcCalibrationPpm10(int32_t units);
int32_t rtcCalibrationUnits(int32_t ppm);
// Why the last clock setting did or did not move the calibration
enum {
RTC_CALIB_APPLIED,
RTC_CALIB_NO_REF,
RTC_CALIB_CLOCK_INVALID,
RTC_CALIB_REF_AHEAD,
RTC_CALIB_TOO_SOON,
RTC_CALIB_REF_TOO_OLD,
RTC_CALIB_TOO_SMALL,
RTC_CALIB_TOO_LARGE,
RTC_CALIB_TIME_ZONE,
};
#if defined(DEBUG)
struct RtcCalibReport {
uint8_t result;
gtime_t elapsed;
int32_t errorMs; // clamped, > 0 when the clock runs fast
};
const struct RtcCalibReport * rtcGetCalibrationReport();
const char * rtcCalibrationResultText(uint8_t result);
#endif
// Time of the last known good setting, 0 when unknown
gtime_t rtcGetCalibrationRef();
void rtcSetCalibrationRef(gtime_t t);
void rtcClearCalibrationRef();
// Back to a factory-fresh state, as if the backup domain had been lost
void rtcResetCalibration();
#if defined(__cplusplus) && !defined(SIMU)
extern "C" {
#endif
void gettime(struct gtm * tm);
#if defined(__cplusplus) && !defined(SIMU)
}
#endif