代码拉取完成，页面将自动刷新
同步操作将从 OpenHarmony/docs 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
Provides standard real-time clock (RTC) APIs.
These APIs allow you to perform operations such as reading or writing system time, reading or writing alarm time, setting alarm interrupts, registering alarm callbacks, setting the external frequency, resetting the RTC driver, and customizing RTC configurations. The RTC driver provides precise real time for the operating system (OS). If the OS is powered off, the RTC driver continues to keep track of the system time using an external battery.
Since:
1.0
|
RtcAlarmCallback) (enum RtcAlarmIndex) |
Defines a callback that will be invoked when an alarm is generated at the specified time. |
|
RtcAlarmIndex { RTC_ALARM_INDEX_A = 0, RTC_ALARM_INDEX_B = 1 } |
|
RtcOpen (void) |
struct DevHandle * |
|
RtcReadTime (struct DevHandle *handle, struct RtcTime *time) |
|
|
RtcWriteTime (struct DevHandle *handle, const struct RtcTime *time) |
|
|
RtcReadAlarm (struct DevHandle *handle, enum RtcAlarmIndex alarmIndex, struct RtcTime *time) |
|
|
RtcWriteAlarm (struct DevHandle *handle, enum RtcAlarmIndex alarmIndex, const struct RtcTime *time) |
|
|
RtcRegisterAlarmCallback (struct DevHandle *handle, enum RtcAlarmIndex alarmIndex, RtcAlarmCallback cb) |
Registers RtcAlarmCallback that will be invoked when an alarm is generated at the specified time. |
|
RtcAlarmInterruptEnable (struct DevHandle *handle, enum RtcAlarmIndex alarmIndex, uint8_t enable) |
|
|
RtcGetFreq (struct DevHandle *handle, uint32_t *freq) |
|
|
RtcSetFreq (struct DevHandle *handle, uint32_t freq) |
Sets the frequency of the external crystal oscillator connected to the RTC driver. |
|
RtcReadReg (struct DevHandle *handle, uint8_t usrDefIndex, uint8_t *value) |
Reads the configuration of a custom RTC register based on the register index. |
|
RtcWriteReg (struct DevHandle *handle, uint8_t usrDefIndex, uint8_t value) |
Writes the configuration of a custom RTC register based on the register index. |
typedef int32_t(* RtcAlarmCallback) (enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330))
Description:
Defines a callback that will be invoked when an alarm is generated at the specified time.
enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330)
Description:
Enumerates alarm indexes.
The alarm indexes will be used when you perform operations related to alarms.
| RTC_ALARM_INDEX_A | |
| RTC_ALARM_INDEX_B |
int32_t RtcAlarmInterruptEnable (struct [DevHandle](DevHandle.md) * handle, enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330) alarmIndex, uint8_t enable )
Description:
Enables or disables alarm interrupts.
Before performing alarm operations, you need to call this function to enable alarm interrupts, so that the RtcRegisterAlarmCallback will be called when the alarm is not generated upon a timeout.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| alarmIndex | Indicates the RTC alarm index. For details, see RtcAlarmIndex. |
| enable | Specifies whether to enable RTC alarm interrupts. The value 1 means to enable alarm interrupts and value 0 means to disable alarm interrupts. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
void RtcClose (struct [DevHandle](DevHandle.md) * handle)
Description:
Releases a specified handle of the RTC device.
Parameters:
| handle | Indicates the pointer to the RTC device handle to release, which is created via RtcGetHandle. |
int32_t RtcGetFreq (struct [DevHandle](DevHandle.md) * handle, uint32_t * freq )
Description:
Reads the RTC external frequency.
This function reads the frequency of the external crystal oscillator connected to the RTC driver.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| freq | Indicates the pointer to the frequency of the external crystal oscillator, in Hz. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
struct [DevHandle](DevHandle.md)* RtcOpen (void )
Description:
Opens the RTC device to obtain its handle.
The OS supports only one RTC device.
Returns:
Returns DevHandle if the operation is successful; returns NULL if the operation fails.
int32_t RtcReadAlarm (struct [DevHandle](DevHandle.md) * handle, enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330) alarmIndex, struct [RtcTime](RtcTime.md) * time )
Description:
Reads the RTC alarm time that was set last time.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| alarmIndex | Indicates the RTC alarm index. For details, see RtcAlarmIndex. |
| time | Indicates the pointer to the RTC alarm time information. For details, see RtcTime. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcReadReg (struct [DevHandle](DevHandle.md) * handle, uint8_t usrDefIndex, uint8_t * value )
Description:
Reads the configuration of a custom RTC register based on the register index.
One index corresponds to one byte of the configuration value.
Parameters:
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcReadTime (struct [DevHandle](DevHandle.md) * handle, struct [RtcTime](RtcTime.md) * time )
Description:
Reads time from the RTC driver.
The time information includes the year, month, day, day of the week, hour, minute, second, and millisecond.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| time | Indicates the pointer to the time information read from the RTC driver. For details, see RtcTime. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcRegisterAlarmCallback (struct [DevHandle](DevHandle.md) * handle, enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330) alarmIndex, [RtcAlarmCallback](RTC.md#gaf9932b7e647bce0503f1314bbe5eef8d) cb )
Description:
Registers RtcAlarmCallback that will be invoked when an alarm is generated at the specified time.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| alarmIndex | Indicates the RTC alarm index. For details, see RtcAlarmIndex. |
| cb | Indicates the callback to register. For details, see RtcAlarmCallback. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcReset (struct [DevHandle](DevHandle.md) * handle)
Description:
Resets the RTC driver.
After the reset, the configuration registers are restored to the default values.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcSetFreq (struct [DevHandle](DevHandle.md) * handle, uint32_t freq )
Description:
Sets the frequency of the external crystal oscillator connected to the RTC driver.
Note that the frequency must be configured in accordance with the requirements specified in the product manual of the in-use component.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| freq | Indicates the frequency to set for the external crystal oscillator, in Hz. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcWriteAlarm (struct [DevHandle](DevHandle.md) * handle, enum [RtcAlarmIndex](RTC.md#gad7b3a575c848e2669db5e5b6f7e74330) alarmIndex, const struct [RtcTime](RtcTime.md) * time )
Description:
Writes the RTC alarm time based on the alarm index.
Note that the RTC start time is 1970/01/01 Thursday 00:00:00 (UTC). Set the maximum value of year based on the requirements specified in the product manual of the in-use component.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| alarmIndex | Indicates the RTC alarm index. For details, see RtcAlarmIndex. |
| tm | Indicates the pointer to the RTC alarm time information. For details, see RtcTime. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcWriteReg (struct [DevHandle](DevHandle.md) * handle, uint8_t usrDefIndex, uint8_t value )
Description:
Writes the configuration of a custom RTC register based on the register index.
One index corresponds to one byte of the configuration value.
Parameters:
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
int32_t RtcWriteTime (struct [DevHandle](DevHandle.md) * handle, const struct [RtcTime](RtcTime.md) * time )
Description:
Writes format-compliant time to the RTC driver.
Note that the RTC start time is 1970/01/01 Thursday 00:00:00 (UTC). Set the maximum value of year based on the requirements specified in the product manual of the in-use component.
Parameters:
| handle | Indicates the pointer to the RTC device handle, which is obtained via RtcGetHandle. |
| time | Indicates the pointer to the time information to write. For details, see RtcTime. |
Returns:
Returns 0 if the operation is successful; returns a negative value if the operation fails. For details, see HDF_STATUS.
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。