RTC 接口更多...

结构体
struct	xt_hal_rtc_tm
	RTC 时间结构体更多...

类型定义
typedef uint32_t	xt_hal_rtc_timestamp_t
	RTC 时间戳类型
typedef void(*	xt_hal_rtc_cb_t) (uint8_t id, uint32_t event_id)
	RTC 回调函数类型

枚举
enum	xt_hal_rtc_event_id { XT_HAL_RTC_ALARM = 0x00 }
	RTC 事件类型枚举更多...

函数
xt_err_t	xt_hal_rtc_set_time (struct xt_hal_rtc_tm *tm)
	设置 RTC 时间
xt_err_t	xt_hal_rtc_get_time (struct xt_hal_rtc_tm *tm)
	获取 RTC 时间
xt_hal_rtc_timestamp_t	xt_hal_rtc_get_timestamp (void)
	获取 RTC 时间戳
xt_err_t	xt_hal_rtc_setup_alarm (uint8_t id, struct xt_hal_rtc_tm *tm, xt_hal_rtc_cb_t cb)
	设置 RTC 闹钟
xt_err_t	xt_hal_rtc_setup_alarm_relative (uint8_t id, uint32_t timeout_ms, xt_hal_rtc_cb_t cb)
	增量设置 RTC 闹钟
xt_err_t	xt_hal_rtc_close_alarm (uint8_t id)
	关闭 RTC 闹钟
xt_err_t	xt_hal_rtc_get_alarm (uint8_t id, struct xt_hal_rtc_tm *tm)
	获取 RTC 闹钟信息
xt_err_t	xt_hal_rtc_set_timezone (int8_t zone)
	设置 RTC 时区
xt_err_t	xt_hal_rtc_get_timezone (int8_t *zone)
	获取 RTC 时区

详细描述

RTC 接口

类型定义说明

◆ xt_hal_rtc_cb_t

typedef void(* xt_hal_rtc_cb_t) (uint8_t id, uint32_t event_id)

RTC 回调函数类型

参数

id	闹钟 ID
event_id	事件类型，见 xt_hal_rtc_event_id

在文件 xt_hal_rtc.h 第 75 行定义.

◆ xt_hal_rtc_timestamp_t

typedef uint32_t xt_hal_rtc_timestamp_t

RTC 时间戳类型

在文件 xt_hal_rtc.h 第 39 行定义.

枚举类型说明

◆ xt_hal_rtc_event_id

enum xt_hal_rtc_event_id

RTC 事件类型枚举

枚举值
XT_HAL_RTC_ALARM	RTC 闹钟事件

在文件 xt_hal_rtc.h 第 65 行定义.

函数说明

◆ xt_hal_rtc_close_alarm()

xt_err_t xt_hal_rtc_close_alarm ( uint8_t id )

关闭 RTC 闹钟

参数

id	闹钟 ID，取值范围见 xt_soc.h 中 xt_hal_rtc_alarm_id

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_get_alarm()

xt_err_t xt_hal_rtc_get_alarm	(	uint8_t	id,
		struct xt_hal_rtc_tm *	tm )

获取 RTC 闹钟信息

参数

	id	闹钟 ID，取值范围见 xt_soc.h 中 xt_hal_rtc_alarm_id
[out]	tm	时间结构体指针，用于返回闹钟触发时间

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_get_time()

xt_err_t xt_hal_rtc_get_time ( struct xt_hal_rtc_tm * tm )

获取 RTC 时间

参数

tm	时间结构体指针，用于返回获取到的时间

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_get_timestamp()

xt_hal_rtc_timestamp_t xt_hal_rtc_get_timestamp ( void )

获取 RTC 时间戳

返回: xt_hal_rtc_timestamp_t UNIX 时间戳（从 1970-01-01 00:00:00 开始的秒数）

◆ xt_hal_rtc_get_timezone()

xt_err_t xt_hal_rtc_get_timezone ( int8_t * zone )

获取 RTC 时区

参数

[out] zone 时区值指针，用于返回当前设置的时区

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_set_time()

xt_err_t xt_hal_rtc_set_time ( struct xt_hal_rtc_tm * tm )

设置 RTC 时间

参数

tm 时间结构体指针

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_set_timezone()

xt_err_t xt_hal_rtc_set_timezone ( int8_t zone )

设置 RTC 时区

参数

zone	时区值，单位为 15 分钟（例如：东八区为 32，即 8*4=32 个 15 分钟）

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_setup_alarm()

xt_err_t xt_hal_rtc_setup_alarm	(	uint8_t	id,
		struct xt_hal_rtc_tm *	tm,
		xt_hal_rtc_cb_t	cb )

设置 RTC 闹钟

参数

id	闹钟 ID，取值范围见 xt_soc.h 中 xt_hal_rtc_alarm_id
tm	闹钟触发时间结构体指针
cb	闹钟回调函数指针

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码

◆ xt_hal_rtc_setup_alarm_relative()

xt_err_t xt_hal_rtc_setup_alarm_relative	(	uint8_t	id,
		uint32_t	timeout_ms,
		xt_hal_rtc_cb_t	cb )

增量设置 RTC 闹钟

参数

id	闹钟 ID，取值范围见 xt_soc.h 中 xt_hal_rtc_alarm_id
timeout_ms	闹钟时间（单位毫秒，实际精度由平台定义，可能只有秒级精度）
cb	闹钟回调函数指针

返回: xt_err_t 成功返回 XT_EOK，失败返回错误码