xt-sdk 文档
v1.0.3
xt-sdk 嵌入式 SDK API 参考
Toggle main menu visibility
载入中...
搜索中...
未找到
xt_hal_rtc.h
浏览该文件的文档.
1
12
13
#ifndef __XT_HAL_RTC_H__
14
#define __XT_HAL_RTC_H__
15
16
/* ==================== [Includes] ========================================== */
17
18
#include "
xt_hal_internal.h
"
19
20
#ifdef __cplusplus
21
extern
"C"
{
22
#endif
23
30
31
/* ==================== [Defines] =========================================== */
32
33
/* ==================== [Typedefs] ========================================== */
34
38
#if !defined(XT_HAL_RTC_TIME_64BITS)
39
typedef
uint32_t
xt_hal_rtc_timestamp_t
;
40
#else
41
typedef
uint64_t
xt_hal_rtc_timestamp_t
;
42
#endif
43
49
struct
xt_hal_rtc_tm
{
50
int
tm_msec
;
51
int
tm_sec
;
52
int
tm_min
;
53
int
tm_hour
;
54
int
tm_mday
;
55
int
tm_mon
;
56
int
tm_year
;
57
int
tm_wday
;
58
int
tm_yday
;
59
int
tm_isdst
;
60
};
61
65
enum
xt_hal_rtc_event_id
{
66
XT_HAL_RTC_ALARM
= 0x00,
67
};
68
75
typedef
void (*
xt_hal_rtc_cb_t
)(uint8_t id, uint32_t event_id);
76
77
/* ==================== [Global Prototypes] ================================= */
78
85
xt_err_t
xt_hal_rtc_set_time
(
struct
xt_hal_rtc_tm
*tm);
86
93
xt_err_t
xt_hal_rtc_get_time
(
struct
xt_hal_rtc_tm
*tm);
94
100
xt_hal_rtc_timestamp_t
xt_hal_rtc_get_timestamp
(
void
);
101
110
xt_err_t
xt_hal_rtc_setup_alarm
(uint8_t
id
,
struct
xt_hal_rtc_tm
*tm,
xt_hal_rtc_cb_t
cb);
111
120
xt_err_t
xt_hal_rtc_setup_alarm_relative
(uint8_t
id
, uint32_t timeout_ms,
xt_hal_rtc_cb_t
cb);
121
128
xt_err_t
xt_hal_rtc_close_alarm
(uint8_t
id
);
129
137
xt_err_t
xt_hal_rtc_get_alarm
(uint8_t
id
,
struct
xt_hal_rtc_tm
*tm);
138
145
xt_err_t
xt_hal_rtc_set_timezone
(int8_t zone);
146
153
xt_err_t
xt_hal_rtc_get_timezone
(int8_t *zone);
154
155
/* ==================== [Macros] ============================================ */
156
/* xt_hal_rtc */
158
159
#ifdef __cplusplus
160
}
/* extern "C" */
161
#endif
162
163
#endif
/* __XT_HAL_RTC_H__ */
xt_err_t
int32_t xt_err_t
错误码类型
定义
xt_error.h:38
xt_hal_rtc_timestamp_t
uint32_t xt_hal_rtc_timestamp_t
RTC 时间戳类型
定义
xt_hal_rtc.h:39
xt_hal_rtc_close_alarm
xt_err_t xt_hal_rtc_close_alarm(uint8_t id)
关闭 RTC 闹钟
xt_hal_rtc_set_timezone
xt_err_t xt_hal_rtc_set_timezone(int8_t zone)
设置 RTC 时区
xt_hal_rtc_set_time
xt_err_t xt_hal_rtc_set_time(struct xt_hal_rtc_tm *tm)
设置 RTC 时间
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 闹钟
xt_hal_rtc_get_timestamp
xt_hal_rtc_timestamp_t xt_hal_rtc_get_timestamp(void)
获取 RTC 时间戳
xt_hal_rtc_event_id
xt_hal_rtc_event_id
RTC 事件类型枚举
定义
xt_hal_rtc.h:65
xt_hal_rtc_get_time
xt_err_t xt_hal_rtc_get_time(struct xt_hal_rtc_tm *tm)
获取 RTC 时间
xt_hal_rtc_get_timezone
xt_err_t xt_hal_rtc_get_timezone(int8_t *zone)
获取 RTC 时区
xt_hal_rtc_cb_t
void(* xt_hal_rtc_cb_t)(uint8_t id, uint32_t event_id)
RTC 回调函数类型
定义
xt_hal_rtc.h:75
xt_hal_rtc_get_alarm
xt_err_t xt_hal_rtc_get_alarm(uint8_t id, struct xt_hal_rtc_tm *tm)
获取 RTC 闹钟信息
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 闹钟
XT_HAL_RTC_ALARM
@ XT_HAL_RTC_ALARM
定义
xt_hal_rtc.h:66
xt_hal_rtc_tm
RTC 时间结构体
定义
xt_hal_rtc.h:49
xt_hal_rtc_tm::tm_hour
int tm_hour
定义
xt_hal_rtc.h:53
xt_hal_rtc_tm::tm_yday
int tm_yday
定义
xt_hal_rtc.h:58
xt_hal_rtc_tm::tm_mday
int tm_mday
定义
xt_hal_rtc.h:54
xt_hal_rtc_tm::tm_msec
int tm_msec
定义
xt_hal_rtc.h:50
xt_hal_rtc_tm::tm_min
int tm_min
定义
xt_hal_rtc.h:52
xt_hal_rtc_tm::tm_mon
int tm_mon
定义
xt_hal_rtc.h:55
xt_hal_rtc_tm::tm_wday
int tm_wday
定义
xt_hal_rtc.h:57
xt_hal_rtc_tm::tm_sec
int tm_sec
定义
xt_hal_rtc.h:51
xt_hal_rtc_tm::tm_year
int tm_year
定义
xt_hal_rtc.h:56
xt_hal_rtc_tm::tm_isdst
int tm_isdst
定义
xt_hal_rtc.h:59
xt_hal_internal.h
XTINY HAL 内部公共头文件
platforms
components
xtiny
xt_hal
xt_hal_rtc.h
生成于
, 为 xt-sdk 文档使用
1.17.0