rtc_helper.h File Reference

Detailed Description

Real Time Clock helper.

Date

Feb 5, 2014

Author

Andrey Belomutskiy, (c) 2012-2020

Nathan Schulte, (c) 2022

Definition in file rtc_helper.h.

Functions
void	initRtc ()
void	printRtcDateTime ()
uint32_t	getEpochTime ()
efidatetime_t	getRtcDateTime ()
void	setRtcDateTime (const efidatetime_t *const dateTime)
efidatetime_t	convertRtcDateTimeToEfi (const RTCDateTime *const timespec)
RTCDateTime	convertRtcDateTimeFromEfi (const efidatetime_t *const dateTime)
bool	dateToStringShort (char *lcd_str)

Function Documentation

convertRtcDateTimeFromEfi()

RTCDateTime convertRtcDateTimeFromEfi

(

const efidatetime_t *const

dateTime

)

Definition at line 100 of file rtc_helper.cpp.

                                                                            {
    RTCDateTime timespec;
    timespec.year = dateTime->year - RTC_BASE_YEAR; // ChibiOS year origin is e.g. 1980
    timespec.month = dateTime->month; // [1..12]
    timespec.day = dateTime->day; // [1..31]
    timespec.millisecond = (((dateTime->hour * 60) + dateTime->minute) * 60 + dateTime->second) * 1000; // ms since midnight
    timespec.dayofweek = RTC_DAY_CATURDAY; // CATURDAY: 0 ... ?
    timespec.dstflag = 0; // 0 ... ?
    return timespec;
}

Referenced by setRtcDateTime().

Here is the caller graph for this function:

convertRtcDateTimeToEfi()

efidatetime_t convertRtcDateTimeToEfi

(

const RTCDateTime *const

timespec

)

Definition at line 82 of file rtc_helper.cpp.

                                                                          {
    uint32_t second = timespec->millisecond / 1000;
    uint16_t minute = second / 60;
    second -= minute * 60;
    uint8_t hour = minute / 60;
    minute -= hour * 60;
 
    efidatetime_t const dateTime = {
        .year = timespec->year + RTC_BASE_YEAR,
        .month = (uint8_t)timespec->month,
        .day = (uint8_t)timespec->day,
        .hour = hour,
        .minute = (uint8_t)minute,
        .second = (uint8_t)second,
    };
    return dateTime;
}

Referenced by getRtcDateTime().

Here is the caller graph for this function:

dateToStringShort()

bool dateToStringShort

(

char *

destination

)

Returns

true if we seem to know current date, false if no valid RTC state

Definition at line 131 of file rtc_helper.cpp.

                                          {
#if EFI_RTC
    strcpy(destination, "000000_000000\0");
    efidatetime_t dateTime = getRtcDateTime();
    if (dateTime.year < 2016 || dateTime.year > 2030) {
        // 2016 to 2030 is the valid range
        destination[0] = 0;
        return false;
    }
 
    putTwoSymbolDecimal(0, destination, dateTime.year % 100);       // year, format as just the last two digits
    putTwoSymbolDecimal(2, destination, dateTime.month);            // month    1-12
    putTwoSymbolDecimal(4, destination, dateTime.day);              // day of the month 1-31
 
    putTwoSymbolDecimal(7, destination, dateTime.hour);         // hours since midnight 0-23
    putTwoSymbolDecimal(9, destination, dateTime.minute);           // minutes
    putTwoSymbolDecimal(11, destination, dateTime.second);          // seconds
 
    return true;
#else // EFI_RTC
    destination[0] = 0;
    return false;
#endif // EFI_RTC
}

Referenced by prepareLogFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

getEpochTime()

uint32_t getEpochTime

(

)

Definition at line 70 of file rtc_helper.cpp.

                        {
    RTCDateTime timespec;
    rtcGetTime(&RTCD1, &timespec);
    return rtc_encode(&timespec);
}

Referenced by updateDevConsoleState().

Here is the call graph for this function:

Here is the caller graph for this function:

getRtcDateTime()

efidatetime_t getRtcDateTime

(

)

Definition at line 76 of file rtc_helper.cpp.

                               {
    RTCDateTime timespec;
    rtcGetTime(&RTCD1, &timespec);
    return convertRtcDateTimeToEfi(&timespec);
}

Referenced by canDashboardBmwE90(), dateToStringShort(), onGpsMessage(), and printRtcDateTime().

Here is the call graph for this function:

Here is the caller graph for this function:

initRtc()

void initRtc

(

)

Definition at line 35 of file rtc_helper.cpp.

               {
    efiPrintf("initRtc()");
    hal_lld_rtc_fixup();
    printDateTime(); // this would test RTC, see #311
}

Referenced by initHardwareNoConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

printRtcDateTime()

void printRtcDateTime

(

)

Definition at line 48 of file rtc_helper.cpp.

                        {
    efidatetime_t dateTime = getRtcDateTime();
    // prints the date like: 19 sep 2022 21:19:55
    efiPrintf("Current RTC time: %02u %s %04lu %02u:%02u:%02u",
            dateTime.day, monthAbbrs[dateTime.month - 1], dateTime.year,
            dateTime.hour, dateTime.minute, dateTime.second);
}

Referenced by printDateTime(), and setDateTime().

Here is the call graph for this function:

Here is the caller graph for this function:

setRtcDateTime()

void setRtcDateTime

(

const efidatetime_t *const

dateTime

)

Definition at line 56 of file rtc_helper.cpp.

                                                          {
    RTCDateTime timespec = convertRtcDateTimeFromEfi(dateTime);
    rtcSetTime(&RTCD1, &timespec);
}

Referenced by onGpsMessage(), and setDateTime().

Here is the call graph for this function:

Here is the caller graph for this function:

Go to the source code of this file.