mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-27 06:50:21 +00:00
f10e82c64d
* Locale settings * Time/date format fix * Locale: add docs, enums for HAL, cleanup. Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
254 lines
6.4 KiB
C
254 lines
6.4 KiB
C
/**
|
|
* @file furi_hal_rtc.h
|
|
* Furi Hal RTC API
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct {
|
|
// Time
|
|
uint8_t hour; /**< Hour in 24H format: 0-23 */
|
|
uint8_t minute; /**< Minute: 0-59 */
|
|
uint8_t second; /**< Second: 0-59 */
|
|
// Date
|
|
uint8_t day; /**< Current day: 1-31 */
|
|
uint8_t month; /**< Current month: 1-12 */
|
|
uint16_t year; /**< Current year: 2000-2099 */
|
|
uint8_t weekday; /**< Current weekday: 1-7 */
|
|
} FuriHalRtcDateTime;
|
|
|
|
typedef enum {
|
|
FuriHalRtcFlagDebug = (1 << 0),
|
|
FuriHalRtcFlagFactoryReset = (1 << 1),
|
|
FuriHalRtcFlagLock = (1 << 2),
|
|
FuriHalRtcFlagC2Update = (1 << 3),
|
|
} FuriHalRtcFlag;
|
|
|
|
typedef enum {
|
|
FuriHalRtcBootModeNormal = 0, /**< Normal boot mode, default value */
|
|
FuriHalRtcBootModeDfu, /**< Boot to DFU (MCU bootloader by ST) */
|
|
FuriHalRtcBootModePreUpdate, /**< Boot to Update, pre update */
|
|
FuriHalRtcBootModeUpdate, /**< Boot to Update, main */
|
|
FuriHalRtcBootModePostUpdate, /**< Boot to Update, post update */
|
|
} FuriHalRtcBootMode;
|
|
|
|
typedef enum {
|
|
FuriHalRtcHeapTrackModeNone = 0, /**< Disable allocation tracking */
|
|
FuriHalRtcHeapTrackModeMain, /**< Enable allocation tracking for main application thread */
|
|
FuriHalRtcHeapTrackModeTree, /**< Enable allocation tracking for main and children application threads */
|
|
FuriHalRtcHeapTrackModeAll, /**< Enable allocation tracking for all threads */
|
|
} FuriHalRtcHeapTrackMode;
|
|
|
|
typedef enum {
|
|
FuriHalRtcRegisterHeader, /**< RTC structure header */
|
|
FuriHalRtcRegisterSystem, /**< Various system bits */
|
|
FuriHalRtcRegisterVersion, /**< Pointer to Version */
|
|
FuriHalRtcRegisterLfsFingerprint, /**< LFS geometry fingerprint */
|
|
FuriHalRtcRegisterFaultData, /**< Pointer to last fault message */
|
|
FuriHalRtcRegisterPinFails, /**< Failed pins count */
|
|
/* Index of FS directory entry corresponding to FW update to be applied */
|
|
FuriHalRtcRegisterUpdateFolderFSIndex,
|
|
|
|
FuriHalRtcRegisterMAX, /**< Service value, do not use */
|
|
} FuriHalRtcRegister;
|
|
|
|
typedef enum {
|
|
FuriHalRtcLocaleUnitsMetric = 0, /**< Metric measurement units */
|
|
FuriHalRtcLocaleUnitsImperial = 1, /**< Imperial measurement units */
|
|
} FuriHalRtcLocaleUnits;
|
|
|
|
typedef enum {
|
|
FuriHalRtcLocaleTimeFormat24h = 0, /**< 24-hour format */
|
|
FuriHalRtcLocaleTimeFormat12h = 1, /**< 12-hour format */
|
|
} FuriHalRtcLocaleTimeFormat;
|
|
|
|
typedef enum {
|
|
FuriHalRtcLocaleDateFormatDMY = 0, /**< Day/Month/Year */
|
|
FuriHalRtcLocaleDateFormatMDY = 1, /**< Month/Day/Year */
|
|
FuriHalRtcLocaleDateFormatYMD = 2, /**< Year/Month/Day */
|
|
} FuriHalRtcLocaleDateFormat;
|
|
|
|
/** Early initialization */
|
|
void furi_hal_rtc_init_early();
|
|
|
|
/** Early de-initialization */
|
|
void furi_hal_rtc_deinit_early();
|
|
|
|
/** Initialize RTC subsystem */
|
|
void furi_hal_rtc_init();
|
|
|
|
/** Get RTC register content
|
|
*
|
|
* @param[in] reg The register identifier
|
|
*
|
|
* @return content of the register
|
|
*/
|
|
uint32_t furi_hal_rtc_get_register(FuriHalRtcRegister reg);
|
|
|
|
/** Set register content
|
|
*
|
|
* @param[in] reg The register identifier
|
|
* @param[in] value The value to store into register
|
|
*/
|
|
void furi_hal_rtc_set_register(FuriHalRtcRegister reg, uint32_t value);
|
|
|
|
/** Set Log Level value
|
|
*
|
|
* @param[in] level The level to store
|
|
*/
|
|
void furi_hal_rtc_set_log_level(uint8_t level);
|
|
|
|
/** Get Log Level value
|
|
*
|
|
* @return The Log Level value
|
|
*/
|
|
uint8_t furi_hal_rtc_get_log_level();
|
|
|
|
/** Set RTC Flag
|
|
*
|
|
* @param[in] flag The flag to set
|
|
*/
|
|
void furi_hal_rtc_set_flag(FuriHalRtcFlag flag);
|
|
|
|
/** Reset RTC Flag
|
|
*
|
|
* @param[in] flag The flag to reset
|
|
*/
|
|
void furi_hal_rtc_reset_flag(FuriHalRtcFlag flag);
|
|
|
|
/** Check if RTC Flag is set
|
|
*
|
|
* @param[in] flag The flag to check
|
|
*
|
|
* @return true if set
|
|
*/
|
|
bool furi_hal_rtc_is_flag_set(FuriHalRtcFlag flag);
|
|
|
|
/** Set RTC boot mode
|
|
*
|
|
* @param[in] mode The mode to set
|
|
*/
|
|
void furi_hal_rtc_set_boot_mode(FuriHalRtcBootMode mode);
|
|
|
|
/** Get RTC boot mode
|
|
*
|
|
* @return The RTC boot mode.
|
|
*/
|
|
FuriHalRtcBootMode furi_hal_rtc_get_boot_mode();
|
|
|
|
/** Set Heap Track mode
|
|
*
|
|
* @param[in] mode The mode to set
|
|
*/
|
|
void furi_hal_rtc_set_heap_track_mode(FuriHalRtcHeapTrackMode mode);
|
|
|
|
/** Get RTC Heap Track mode
|
|
*
|
|
* @return The RTC heap track mode.
|
|
*/
|
|
FuriHalRtcHeapTrackMode furi_hal_rtc_get_heap_track_mode();
|
|
|
|
/** Set locale units
|
|
*
|
|
* @param[in] mode The RTC Locale Units
|
|
*/
|
|
void furi_hal_rtc_set_locale_units(FuriHalRtcLocaleUnits value);
|
|
|
|
/** Get RTC Locale Units
|
|
*
|
|
* @return The RTC Locale Units.
|
|
*/
|
|
FuriHalRtcLocaleUnits furi_hal_rtc_get_locale_units();
|
|
|
|
/** Set RTC Locale Time Format
|
|
*
|
|
* @param[in] value The RTC Locale Time Format
|
|
*/
|
|
void furi_hal_rtc_set_locale_timeformat(FuriHalRtcLocaleTimeFormat value);
|
|
|
|
/** Get RTC Locale Time Format
|
|
*
|
|
* @return The RTC Locale Time Format.
|
|
*/
|
|
FuriHalRtcLocaleTimeFormat furi_hal_rtc_get_locale_timeformat();
|
|
|
|
/** Set RTC Locale Date Format
|
|
*
|
|
* @param[in] value The RTC Locale Date Format
|
|
*/
|
|
void furi_hal_rtc_set_locale_dateformat(FuriHalRtcLocaleDateFormat value);
|
|
|
|
/** Get RTC Locale Date Format
|
|
*
|
|
* @return The RTC Locale Date Format
|
|
*/
|
|
FuriHalRtcLocaleDateFormat furi_hal_rtc_get_locale_dateformat();
|
|
|
|
/** Set RTC Date Time
|
|
*
|
|
* @param datetime The date time to set
|
|
*/
|
|
void furi_hal_rtc_set_datetime(FuriHalRtcDateTime* datetime);
|
|
|
|
/** Get RTC Date Time
|
|
*
|
|
* @param datetime The datetime
|
|
*/
|
|
void furi_hal_rtc_get_datetime(FuriHalRtcDateTime* datetime);
|
|
|
|
/** Validate Date Time
|
|
*
|
|
* @param datetime The datetime to validate
|
|
*
|
|
* @return { description_of_the_return_value }
|
|
*/
|
|
bool furi_hal_rtc_validate_datetime(FuriHalRtcDateTime* datetime);
|
|
|
|
/** Set RTC Fault Data
|
|
*
|
|
* @param[in] value The value
|
|
*/
|
|
void furi_hal_rtc_set_fault_data(uint32_t value);
|
|
|
|
/** Get RTC Fault Data
|
|
*
|
|
* @return RTC Fault Data value
|
|
*/
|
|
uint32_t furi_hal_rtc_get_fault_data();
|
|
|
|
/** Set Pin Fails count
|
|
*
|
|
* @param[in] value The Pin Fails count
|
|
*/
|
|
void furi_hal_rtc_set_pin_fails(uint32_t value);
|
|
|
|
/** Get Pin Fails count
|
|
*
|
|
* @return Pin Fails Count
|
|
*/
|
|
uint32_t furi_hal_rtc_get_pin_fails();
|
|
|
|
/** Get UNIX Timestamp
|
|
*
|
|
* @return Unix Timestamp in seconds from UNIX epoch start
|
|
*/
|
|
uint32_t furi_hal_rtc_get_timestamp();
|
|
|
|
/** Convert DateTime to UNIX timestamp
|
|
*
|
|
* @param datetime The datetime
|
|
*
|
|
* @return UNIX Timestamp in seconds from UNIX epoch start
|
|
*/
|
|
uint32_t furi_hal_rtc_datetime_to_timestamp(FuriHalRtcDateTime* datetime);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|