DS3231.h File Reference

#include "rtc/rtc.h"

Go to the source code of this file.

Overview

DS3231 Driver API definitions. This file provides data structures and APIs for controlling the DS3231 RTC device on the EfxSapphireSoC platform.

Author

Efinix Inc

Note

This is a device-specific driver implementation for the DS3231 RTC.

Copyright

2013-2026 Efinix Inc. All rights reserved.
See the full License Information for Efinix and SaxonSoc MIT terms.

Definition in file DS3231.h.

Macros
#define	RTC_DS3231_ADDR   0x68<<1
	I2C Address for DS3231 RTC device.

Functions
rtc_status_t	DS3231_applyConfig (rtc_instance_t *rtc)
	Apply I2C + RTC configuration.
rtc_status_t	DS3231_enableErrorInterrupt (rtc_instance_t *rtc)
	Enable error interrupt for DS3231 RTC.
rtc_status_t	DS3231_getTime (rtc_instance_t *rtc)
	Get time from DS3231 RTC.
rtc_status_t	DS3231_setTime (rtc_instance_t *rtc)
	Set time on DS3231 RTC.
rtc_status_t	DS3231_setTimeSystem (rtc_instance_t *rtc, u8 use_12hour_mode)
	Set time system (12-hour or 24-hour) on DS3231 RTC.

Variables
const rtc_api_t	DS3231_DRIVER
	DS3231 Driver Instance. Point your generic RTC pointer to this structure to use the DS3231 hardware.