RV32 SoC DS UG
High-Perf RV32 SoC DS UG
RV64 SoC DS UG API and Examples
Embedded IDE UG
Loading...
Searching...
No Matches
API Functions
Hardware Drivers » Timers & Clocks » Real Time Clock (RTC) Driver » Supported Devices » PCF8523 RTC Driver

Overview

Function definitions for PCF8523 driver.

Note
This is the public API for the PCF8523 RTC device.

Functions

rtc_status_t PCF8523_applyConfig (rtc_instance_t *rtc)
 Apply I2C + RTC configuration.
rtc_status_t PCF8523_enableErrorInterrupt (rtc_instance_t *rtc)
 Enable error interrupt for PCF8523 RTC.
rtc_status_t PCF8523_getCSR (rtc_instance_t *rtc)
 Get control/status register from PCF8523 RTC.
rtc_status_t PCF8523_getTime (rtc_instance_t *rtc)
 Get time from PCF8523 RTC.
rtc_status_t PCF8523_setTime (rtc_instance_t *rtc)
 Set time on PCF8523 RTC.
rtc_status_t PCF8523_setTimeSystem (rtc_instance_t *rtc, u8 use_12hour_mode)
 Set time system (12-hour or 24-hour) on PCF8523 RTC.

Function Documentation

◆ PCF8523_applyConfig()

rtc_status_t PCF8523_applyConfig ( rtc_instance_t * rtc)

#include <PCF8523.h>

Apply I2C + RTC configuration.

Parameters
rtcPointer to RTC instance.
Returns
Status code of the operation.

Definition at line 65 of file PCF8523.c.

◆ PCF8523_enableErrorInterrupt()

rtc_status_t PCF8523_enableErrorInterrupt ( rtc_instance_t * rtc)

#include <PCF8523.h>

Enable error interrupt for PCF8523 RTC.

Parameters
rtcPointer to RTC instance.
Returns
Status code of the operation.

Definition at line 71 of file PCF8523.c.

◆ PCF8523_getCSR()

rtc_status_t PCF8523_getCSR ( rtc_instance_t * rtc)

#include <PCF8523.h>

Get control/status register from PCF8523 RTC.

Parameters
rtcPointer to RTC instance.
Returns
Status code of the operation.

Definition at line 191 of file PCF8523.c.

◆ PCF8523_getTime()

rtc_status_t PCF8523_getTime ( rtc_instance_t * rtc)

#include <PCF8523.h>

Get time from PCF8523 RTC.

Parameters
rtcPointer to RTC instance.
Returns
Status code of the operation.

Definition at line 78 of file PCF8523.c.

◆ PCF8523_setTime()

rtc_status_t PCF8523_setTime ( rtc_instance_t * rtc)

#include <PCF8523.h>

Set time on PCF8523 RTC.

Parameters
rtcPointer to RTC instance.
Returns
Status code of the operation.

Definition at line 112 of file PCF8523.c.

◆ PCF8523_setTimeSystem()

rtc_status_t PCF8523_setTimeSystem ( rtc_instance_t * rtc,
u8 use_12hour_mode )

#include <PCF8523.h>

Set time system (12-hour or 24-hour) on PCF8523 RTC.

Parameters
rtcPointer to RTC instance.
use_12hour_modeFlag indicating whether to use 12-hour mode (1) or 24-hour mode (0).
Returns
Status code of the operation.

Definition at line 143 of file PCF8523.c.