blob: c028e1cf85d5fdc4944509e11a1bd9d97cfe68a9 [file]
/*
* Copyright (c) 2025 Dipak Shetty
*
* SPDX-License-Identifier: Apache-2.0
*/
#define DT_DRV_COMPAT microcrystal_rv3032
#include <zephyr/kernel.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/drivers/rtc.h>
#include <zephyr/logging/log.h>
#include <zephyr/sys/util.h>
#include <zephyr/drivers/mfd/rv3032.h>
#include "rtc_utils.h"
LOG_MODULE_REGISTER(rv3032, CONFIG_RTC_LOG_LEVEL);
#define RV3032_EEPROM_CLKOUT2_OS_XTAL 0x0
#define RV3032_EEPROM_CLKOUT2_OS_HF 0x1
#define RV3032_EEPROM_CLKOUT2_FD_32768HZ 0x0
#define RV3032_EEPROM_CLKOUT2_FD_1024HZ 0x1
#define RV3032_EEPROM_CLKOUT2_FD_64HZ 0x2
#define RV3032_EEPROM_CLKOUT2_FD_1HZ 0x3
/* CLKOUT frequency constants */
#define RV3032_CLKOUT_FREQ_1HZ 1U
#define RV3032_CLKOUT_FREQ_64HZ 64U
#define RV3032_CLKOUT_FREQ_1024HZ 1024U
#define RV3032_CLKOUT_FREQ_32768HZ 32768U
#define RV3032_CLKOUT_FREQ_HF_MIN 8192U
#define RV3032_CLKOUT_FREQ_HF_MAX 67108864U
#define RV3032_CLKOUT_FREQ_HF_STEP 8192U
/* Number of nanoseconds per 1/100th of a second */
#define RV3032_NSEC_PER_100TH_SECOND 10000000L
/* RTC alarm time fields supported by the RV3032 */
#define RV3032_RTC_ALARM_TIME_MASK \
(RTC_ALARM_TIME_MASK_MINUTE | RTC_ALARM_TIME_MASK_HOUR | RTC_ALARM_TIME_MASK_MONTHDAY)
/* RTC time fields supported by the RV3032 */
#define RV3032_RTC_TIME_MASK \
(RTC_ALARM_TIME_MASK_SECOND | RTC_ALARM_TIME_MASK_MINUTE | RTC_ALARM_TIME_MASK_HOUR | \
RTC_ALARM_TIME_MASK_MONTH | RTC_ALARM_TIME_MASK_MONTHDAY | RTC_ALARM_TIME_MASK_YEAR | \
RTC_ALARM_TIME_MASK_WEEKDAY)
struct rv3032_config {
const struct device *mfd;
uint32_t clkout_freq;
};
struct rv3032_data {
struct k_sem lock;
const struct device *dev;
struct k_work work;
#ifdef CONFIG_RTC_ALARM
rtc_alarm_callback alarm_callback;
void *alarm_user_data;
#endif /* CONFIG_RTC_ALARM */
#ifdef CONFIG_RTC_UPDATE
rtc_update_callback update_callback;
void *update_user_data;
#endif /* CONFIG_RTC_UPDATE */
};
static void rv3032_lock_sem(const struct device *dev)
{
struct rv3032_data *data = dev->data;
(void)k_sem_take(&data->lock, K_FOREVER);
}
static void rv3032_unlock_sem(const struct device *dev)
{
struct rv3032_data *data = dev->data;
k_sem_give(&data->lock);
}
static int rv3032_configure_clkout(const struct device *dev, uint32_t freq)
{
const struct rv3032_config *config = dev->config;
uint8_t clkout1_reg = 0;
uint8_t clkout2_reg = 0;
uint8_t pmu_reg = 0;
uint16_t hfd;
int err;
if (freq == 0) {
/* Disable CLKOUT: NCLKE = 1 for minimum power consumption */
pmu_reg = RV3032_EEPROM_PMU_NCLKE;
/* Registers can be left as 0 (XTAL mode, 32768 Hz, HFD = 0) */
clkout1_reg = 0;
clkout2_reg = 0; /* OS = 0 (XTAL), FD = 00 (32768Hz), HFD[12:8] = 0 */
} else {
/* Enable CLKOUT: NCLKE = 0 */
pmu_reg = 0;
switch (freq) {
case RV3032_CLKOUT_FREQ_1HZ:
clkout1_reg = 0; /* HFD[7:0] not used in XTAL mode */
clkout2_reg =
FIELD_PREP(RV3032_EEPROM_CLKOUT2_OS,
RV3032_EEPROM_CLKOUT2_OS_XTAL) |
FIELD_PREP(RV3032_EEPROM_CLKOUT2_FD, RV3032_EEPROM_CLKOUT2_FD_1HZ);
break;
case RV3032_CLKOUT_FREQ_64HZ:
clkout1_reg = 0; /* HFD[7:0] not used in XTAL mode */
clkout2_reg =
FIELD_PREP(RV3032_EEPROM_CLKOUT2_OS,
RV3032_EEPROM_CLKOUT2_OS_XTAL) |
FIELD_PREP(RV3032_EEPROM_CLKOUT2_FD, RV3032_EEPROM_CLKOUT2_FD_64HZ);
break;
case RV3032_CLKOUT_FREQ_1024HZ:
clkout1_reg = 0; /* HFD[7:0] not used in XTAL mode */
clkout2_reg = FIELD_PREP(RV3032_EEPROM_CLKOUT2_OS,
RV3032_EEPROM_CLKOUT2_OS_XTAL) |
FIELD_PREP(RV3032_EEPROM_CLKOUT2_FD,
RV3032_EEPROM_CLKOUT2_FD_1024HZ);
break;
case RV3032_CLKOUT_FREQ_32768HZ:
clkout1_reg = 0; /* HFD[7:0] not used in XTAL mode */
clkout2_reg = FIELD_PREP(RV3032_EEPROM_CLKOUT2_OS,
RV3032_EEPROM_CLKOUT2_OS_XTAL) |
FIELD_PREP(RV3032_EEPROM_CLKOUT2_FD,
RV3032_EEPROM_CLKOUT2_FD_32768HZ);
break;
default:
hfd = (freq / RV3032_CLKOUT_FREQ_HF_STEP) - 1;
clkout1_reg = FIELD_GET(RV3032_EEPROM_CLKOUT1_HFD_LOW, hfd); /* HFD[7:0] */
clkout2_reg =
FIELD_PREP(RV3032_EEPROM_CLKOUT2_OS, RV3032_EEPROM_CLKOUT2_OS_HF) |
FIELD_PREP(RV3032_EEPROM_CLKOUT2_HFD_HIGH,
(hfd >> 8)); /* HFD[12:8] */
break;
}
}
/* Configure PMU register NCLKE bit */
err = mfd_rv3032_update_cfg(config->mfd, RV3032_REG_EEPROM_PMU, RV3032_EEPROM_PMU_NCLKE,
pmu_reg);
if (err) {
LOG_ERR("Failed to configure PMU NCLKE: %d", err);
return err;
}
/* Write EEPROM Clkout 1 (C2h) */
err = mfd_rv3032_update_cfg(config->mfd, RV3032_REG_EEPROM_CLKOUT1,
RV3032_EEPROM_CLKOUT1_HFD_LOW, clkout1_reg);
if (err) {
LOG_ERR("Failed to configure CLKOUT1 register: %d", err);
return err;
}
/* Write EEPROM Clkout 2 (C3h) */
err = mfd_rv3032_update_cfg(config->mfd, RV3032_REG_EEPROM_CLKOUT2,
RV3032_EEPROM_CLKOUT2_OS | RV3032_EEPROM_CLKOUT2_FD |
RV3032_EEPROM_CLKOUT2_HFD_HIGH,
clkout2_reg);
if (err) {
LOG_ERR("Failed to configure CLKOUT2 register: %d", err);
return err;
}
if (freq == 0) {
LOG_DBG("CLKOUT disabled for power saving");
} else {
LOG_DBG("CLKOUT configured for %u Hz (C2h=0x%02x, C3h=0x%02x)", freq, clkout1_reg,
clkout2_reg);
}
return 0;
}
static int rv3032_set_time(const struct device *dev, const struct rtc_time *timeptr)
{
const struct rv3032_config *config = dev->config;
uint8_t date[7];
int err;
if (!timeptr || !rtc_utils_validate_rtc_time(timeptr, RV3032_RTC_TIME_MASK) ||
(timeptr->tm_year < RV3032_YEAR_OFFSET)) {
LOG_ERR("invalid time");
return -EINVAL;
}
rv3032_lock_sem(dev);
LOG_DBG("set time: year = %d, mon = %d, mday = %d, wday = %d, hour = %d, "
"min = %d, sec = %d, centisec = %d",
timeptr->tm_year, timeptr->tm_mon, timeptr->tm_mday, timeptr->tm_wday,
timeptr->tm_hour, timeptr->tm_min, timeptr->tm_sec,
(int)(timeptr->tm_nsec / RV3032_NSEC_PER_100TH_SECOND));
date[0] = bin2bcd(timeptr->tm_sec) & RV3032_SECONDS_MASK;
date[1] = bin2bcd(timeptr->tm_min) & RV3032_MINUTES_MASK;
date[2] = bin2bcd(timeptr->tm_hour) & RV3032_HOURS_24H_MASK;
date[3] = timeptr->tm_wday & RV3032_WEEKDAY_MASK;
date[4] = bin2bcd(timeptr->tm_mday) & RV3032_DATE_MASK;
date[5] = bin2bcd(timeptr->tm_mon + RV3032_MONTH_OFFSET) & RV3032_MONTH_MASK;
date[6] = bin2bcd(timeptr->tm_year - RV3032_YEAR_OFFSET) & RV3032_YEAR_MASK;
/* Write seconds through year registers. Note: Writing to seconds register automatically
* clears the 100th seconds register to 00h per datasheet
*/
err = mfd_rv3032_write_regs(config->mfd, RV3032_REG_SECONDS, &date, sizeof(date));
if (err) {
goto unlock;
}
/* Clear Power On Reset Flag */
err = mfd_rv3032_update_reg8(config->mfd, RV3032_REG_STATUS, RV3032_STATUS_PORF, 0);
unlock:
rv3032_unlock_sem(dev);
return err;
}
static int rv3032_get_time(const struct device *dev, struct rtc_time *timeptr)
{
const struct rv3032_config *config = dev->config;
uint8_t status;
uint8_t date[8];
int err;
if (!timeptr) {
return -EINVAL;
}
err = mfd_rv3032_read_reg8(config->mfd, RV3032_REG_STATUS, &status);
if (err) {
return err;
}
if (status & RV3032_STATUS_PORF) {
/* Power On Reset Flag indicates invalid data */
return -ENODATA;
}
/* Read 100th seconds through year registers */
err = mfd_rv3032_read_regs(config->mfd, RV3032_REG_100TH_SECONDS, date, ARRAY_SIZE(date));
if (err) {
return err;
}
memset(timeptr, 0U, sizeof(*timeptr));
timeptr->tm_nsec =
bcd2bin(date[0] & RV3032_100TH_SECONDS_MASK) * RV3032_NSEC_PER_100TH_SECOND;
timeptr->tm_sec = bcd2bin(date[1] & RV3032_SECONDS_MASK);
timeptr->tm_min = bcd2bin(date[2] & RV3032_MINUTES_MASK);
timeptr->tm_hour = bcd2bin(date[3] & RV3032_HOURS_24H_MASK);
timeptr->tm_wday = date[4] & RV3032_WEEKDAY_MASK;
timeptr->tm_mday = bcd2bin(date[5] & RV3032_DATE_MASK);
timeptr->tm_mon = bcd2bin(date[6] & RV3032_MONTH_MASK) - RV3032_MONTH_OFFSET;
timeptr->tm_year = bcd2bin(date[7] & RV3032_YEAR_MASK) + RV3032_YEAR_OFFSET;
timeptr->tm_yday = -1;
timeptr->tm_isdst = -1;
LOG_DBG("get time: year = %d, mon = %d, mday = %d, wday = %d, hour = %d, "
"min = %d, sec = %d, centisec = %d",
timeptr->tm_year, timeptr->tm_mon, timeptr->tm_mday, timeptr->tm_wday,
timeptr->tm_hour, timeptr->tm_min, timeptr->tm_sec,
(int)(timeptr->tm_nsec / 10000000));
return 0;
}
#ifdef CONFIG_RTC_ALARM
static int rv3032_alarm_get_supported_fields(const struct device *dev, uint16_t id, uint16_t *mask)
{
ARG_UNUSED(dev);
if (id != 0U) {
LOG_ERR("invalid alarm ID %d", id);
return -EINVAL;
}
*mask = RV3032_RTC_ALARM_TIME_MASK;
return 0;
}
static int rv3032_alarm_set_time(const struct device *dev, uint16_t id, uint16_t mask,
const struct rtc_time *timeptr)
{
const struct rv3032_config *config = dev->config;
uint8_t regs[3];
if (id != 0U) {
LOG_ERR("invalid alarm ID %d", id);
return -EINVAL;
}
if (mask & ~(RV3032_RTC_ALARM_TIME_MASK)) {
LOG_ERR("unsupported alarm field mask 0x%04x", mask);
return -EINVAL;
}
if (!rtc_utils_validate_rtc_time(timeptr, mask)) {
LOG_ERR("invalid alarm time");
return -EINVAL;
}
if (mask & RTC_ALARM_TIME_MASK_MINUTE) {
regs[0] = bin2bcd(timeptr->tm_min) & RV3032_ALARM_MINUTES_MASK;
} else {
regs[0] = RV3032_ALARM_MINUTES_AE_M;
}
if (mask & RTC_ALARM_TIME_MASK_HOUR) {
regs[1] = bin2bcd(timeptr->tm_hour) & RV3032_ALARM_HOURS_24H_MASK;
} else {
regs[1] = RV3032_ALARM_HOURS_AE_H;
}
if (mask & RTC_ALARM_TIME_MASK_MONTHDAY) {
regs[2] = bin2bcd(timeptr->tm_mday) & RV3032_ALARM_DATE_MASK;
} else {
regs[2] = RV3032_ALARM_DATE_AE_D;
}
LOG_DBG("set alarm: mday = %d, hour = %d, min = %d, mask = 0x%04x", timeptr->tm_mday,
timeptr->tm_hour, timeptr->tm_min, mask);
/* Write registers RV3032_REG_ALARM_MINUTES through RV3032_REG_ALARM_DATE */
return mfd_rv3032_write_regs(config->mfd, RV3032_REG_ALARM_MINUTES, &regs,
ARRAY_SIZE(regs));
}
static int rv3032_alarm_get_time(const struct device *dev, uint16_t id, uint16_t *mask,
struct rtc_time *timeptr)
{
const struct rv3032_config *config = dev->config;
uint8_t regs[3];
int err;
if (id != 0U) {
LOG_ERR("invalid alarm ID %d", id);
return -EINVAL;
}
/* Read registers RV3032_REG_ALARM_MINUTES through RV3032_REG_ALARM_WEEKDAY */
err = mfd_rv3032_read_regs(config->mfd, RV3032_REG_ALARM_MINUTES, &regs, ARRAY_SIZE(regs));
if (err) {
return err;
}
memset(timeptr, 0U, sizeof(*timeptr));
*mask = 0U;
if ((regs[0] & RV3032_ALARM_MINUTES_AE_M) == 0) {
timeptr->tm_min = bcd2bin(regs[0] & RV3032_ALARM_MINUTES_MASK);
*mask |= RTC_ALARM_TIME_MASK_MINUTE;
}
if ((regs[1] & RV3032_ALARM_HOURS_AE_H) == 0) {
timeptr->tm_hour = bcd2bin(regs[1] & RV3032_ALARM_HOURS_24H_MASK);
*mask |= RTC_ALARM_TIME_MASK_HOUR;
}
if ((regs[2] & RV3032_ALARM_DATE_AE_D) == 0) {
timeptr->tm_mday = bcd2bin(regs[2] & RV3032_ALARM_DATE_MASK);
*mask |= RTC_ALARM_TIME_MASK_MONTHDAY;
}
LOG_DBG("get alarm: mday = %d, hour = %d, min = %d, mask = 0x%04x", timeptr->tm_mday,
timeptr->tm_hour, timeptr->tm_min, *mask);
return 0;
}
static int rv3032_alarm_is_pending(const struct device *dev, uint16_t id)
{
const struct rv3032_config *config = dev->config;
uint8_t status;
int err;
if (id != 0U) {
LOG_ERR("invalid alarm ID %d", id);
return -EINVAL;
}
rv3032_lock_sem(dev);
err = mfd_rv3032_read_reg8(config->mfd, RV3032_REG_STATUS, &status);
if (err) {
goto unlock;
}
if (status & RV3032_STATUS_AF) {
/* Clear alarm flag */
status &= ~(RV3032_STATUS_AF);
err = mfd_rv3032_write_reg8(config->mfd, RV3032_REG_STATUS, status);
if (err) {
goto unlock;
}
/* Alarm pending */
err = 1;
}
unlock:
rv3032_unlock_sem(dev);
return err;
}
#ifdef CONFIG_RTC_UPDATE
static void rv3032_rtc_update_isr(const struct device *dev)
{
struct rv3032_data *data = dev->data;
rtc_update_callback update_callback = data->update_callback;
void *update_user_data = data->update_user_data;
update_callback(dev, update_user_data);
}
#endif
#ifdef CONFIG_RTC_ALARM
static void rv3032_rtc_alarm_isr(const struct device *dev)
{
struct rv3032_data *data = dev->data;
rtc_alarm_callback alarm_callback = data->alarm_callback;
void *alarm_user_data = data->alarm_user_data;
alarm_callback(dev, 0U, alarm_user_data);
}
#endif
static int rv3032_alarm_set_callback(const struct device *dev, uint16_t id,
rtc_alarm_callback callback, void *user_data)
{
const struct rv3032_config *config = dev->config;
struct rv3032_data *data = dev->data;
int err;
if (id != 0U) {
LOG_ERR("invalid alarm ID %d", id);
return -EINVAL;
}
rv3032_lock_sem(dev);
mfd_rv3032_set_irq_handler(config->mfd, dev, RV3032_DEV_RTC_ALARM, rv3032_rtc_alarm_isr);
data->alarm_callback = callback;
data->alarm_user_data = user_data;
err = mfd_rv3032_update_reg8(config->mfd, RV3032_REG_CONTROL2, RV3032_CONTROL2_AIE,
callback ? RV3032_CONTROL2_AIE : 0);
rv3032_unlock_sem(dev);
return err;
}
#endif /* CONFIG_RTC_ALARM */
#ifdef CONFIG_RTC_UPDATE
static int rv3032_update_set_callback(const struct device *dev, rtc_update_callback callback,
void *user_data)
{
const struct rv3032_config *config = dev->config;
struct rv3032_data *data = dev->data;
int err;
rv3032_lock_sem(dev);
mfd_rv3032_set_irq_handler(config->mfd, dev, RV3032_DEV_RTC_UPDATE, rv3032_rtc_update_isr);
data->update_callback = callback;
data->update_user_data = user_data;
err = mfd_rv3032_update_reg8(config->mfd, RV3032_REG_CONTROL2, RV3032_CONTROL2_UIE,
callback ? RV3032_CONTROL2_UIE : 0);
if (err) {
goto unlock;
}
unlock:
rv3032_unlock_sem(dev);
/* Seconds flag may already be set */
k_work_submit(&data->work);
return err;
}
#endif /* CONFIG_RTC_UPDATE */
static int rv3032_init(const struct device *dev)
{
const struct rv3032_config *config = dev->config;
struct rv3032_data *data = dev->data;
uint8_t regs[3];
uint8_t val;
int err;
uint8_t status;
k_sem_init(&data->lock, 1, 1);
/* Now read status register */
err = mfd_rv3032_read_reg8(config->mfd, RV3032_REG_STATUS, &val);
if (err) {
LOG_ERR("Status register read failed after EEPROM refresh: %d", err);
return err; /* Return actual I2C error code */
}
if (val & RV3032_STATUS_AF) {
LOG_WRN("an alarm may have been missed");
}
/* Refresh the settings in the RAM with the settings from the EEPROM */
err = mfd_rv3032_enter_eerd(config->mfd);
if (err) {
LOG_ERR("Failed to enter EERD mode: %d", err);
return err;
}
err = mfd_rv3032_eeprom_refresh(config->mfd);
if (err) {
LOG_ERR("Failed to refresh EEPROM settings: %d", err);
return err;
}
/* Configure CLKOUT frequency */
err = rv3032_configure_clkout(dev, config->clkout_freq);
if (err) {
LOG_ERR("Failed to configure CLKOUT: %d", err);
return err;
}
err = mfd_rv3032_read_reg8(config->mfd, RV3032_REG_STATUS, &status);
if (err) {
return -ENODEV;
}
/*TODO: block is not needed - delete*/
if (status & RV3032_STATUS_PORF) {
/* Disable the alarms */
err = mfd_rv3032_update_reg8(config->mfd, RV3032_REG_CONTROL2,
RV3032_CONTROL2_AIE | RV3032_CONTROL2_UIE, 0);
if (err) {
return -ENODEV;
}
err = mfd_rv3032_update_reg8(config->mfd, RV3032_REG_STATUS, RV3032_STATUS_PORF, 0);
if (err) {
return -ENODEV;
}
}
err = mfd_rv3032_read_regs(config->mfd, RV3032_REG_ALARM_MINUTES, regs, sizeof(regs));
if (err) {
return -ENODEV;
}
LOG_DBG("%s: RV3032 RTC driver initialized", dev->name);
return 0;
}
static DEVICE_API(rtc, rv3032_driver_api) = {
.set_time = rv3032_set_time,
.get_time = rv3032_get_time,
#ifdef CONFIG_RTC_ALARM
.alarm_get_supported_fields = rv3032_alarm_get_supported_fields,
.alarm_set_time = rv3032_alarm_set_time,
.alarm_get_time = rv3032_alarm_get_time,
.alarm_is_pending = rv3032_alarm_is_pending,
.alarm_set_callback = rv3032_alarm_set_callback,
#endif /* CONFIG_RTC_ALARM */
#ifdef CONFIG_RTC_UPDATE
.update_set_callback = rv3032_update_set_callback,
#endif /* CONFIG_RTC_UPDATE */
};
#define RV3032_CLKOUT_FREQ_IS_VALID(freq) \
((freq) == 0 || (freq) == RV3032_CLKOUT_FREQ_1HZ || (freq) == RV3032_CLKOUT_FREQ_64HZ || \
(freq) == RV3032_CLKOUT_FREQ_1024HZ || (freq) == RV3032_CLKOUT_FREQ_32768HZ || \
(((freq) >= RV3032_CLKOUT_FREQ_HF_MIN) && ((freq) <= RV3032_CLKOUT_FREQ_HF_MAX) && \
(((freq) % RV3032_CLKOUT_FREQ_HF_STEP) == 0)))
#define RV3032_INIT(inst) \
BUILD_ASSERT(RV3032_CLKOUT_FREQ_IS_VALID(DT_INST_PROP_OR(inst, clkout_frequency, 0)), \
"Invalid CLKOUT frequency for RV3032 instance " STRINGIFY(inst)); \
\
static const struct rv3032_config rv3032_config_##inst = { \
.mfd = DEVICE_DT_GET(DT_INST_PARENT(inst)), \
.clkout_freq = DT_INST_PROP_OR(inst, clkout_frequency, 0), \
}; \
static struct rv3032_data rv3032_data_##inst; \
\
DEVICE_DT_INST_DEFINE(inst, &rv3032_init, NULL, &rv3032_data_##inst, \
&rv3032_config_##inst, POST_KERNEL, CONFIG_RTC_INIT_PRIORITY, \
&rv3032_driver_api);
DT_INST_FOREACH_STATUS_OKAY(RV3032_INIT)