Real Time Clock (RTC) Driver

Overview

This module provides Generic Core functions of RTC to configure and control RTC input/output and interrupt behavior.

Usage & Initialization.

This is an example show how to instantiate Real Time Clock (RTC) Driver with rtc_instance_t.

This implementation depends on I2C Driver.

#include "rtc/rtc.h"
 
// I2C instance configuration
#define I2C_FREQ        100000
#define I2C_CTRL_HZ     SYSTEM_CLINT_HZ
#define I2C_CTRL        (i2c_hwreg_t *)SYSTEM_I2C_0_IO_CTRL
 
// RTC instance configuration
#define RTC_CTRL        RTC_DS3231_ADDR
#define RTC_DRIVER      ds3231_driver
 
rtc_instance_t RTC = {
    .drv  = &RTC_DRIVER,
    .inst = &(i2c_instance_t){
        .hwreg                  = I2C_CTRL,
        .slaveAddress           = RTC_CTRL,
        .samplingClockDivider   = 3,
        .timeout                = I2C_CTRL_HZ/1000,
        .tsuDat                 = I2C_CTRL_HZ/(I2C_FREQ*5),
        .tLow                   = I2C_CTRL_HZ/(I2C_FREQ*2),
        .tHigh                  = I2C_CTRL_HZ/(I2C_FREQ*2),
        .tBuf                   = I2C_CTRL_HZ/(I2C_FREQ),
},
};
 RTC.drv->applyConfig(&RTC);
 RTC.drv->enableErrorInterrupt(&RTC);
 RTC.drv->getTime(&RTC);
 printf("Current Time: %02d:%02d:%02d\n", RTC.current_time.hours, RTC.current_time.minutes, RTC.current_time.seconds);

See also

Supported Devices - Learn about the supported Real Time Clock device list.

Example RTC Demo - Learn how to use the driver for Real-Time Clock operations.

Topics
	API Functions
	Function definitions for RTC driver.
	Data Structures
	Structs used by the driver.
	Data Types
	Enums used by the driver.
	Driver Configuration
	Automatic hardware selection logic.
	Supported Devices
	Supported Real Time Clock (RTC) devices.