Commit bd365a0b authored by Chia-Yang Lin's avatar Chia-Yang Lin Committed by Benjamin Cabé
Browse files

drivers: rtc: rts5912: add rtc driver 

Add rtc driver for Realtek rts5912.

Signed-off-by: default avatarChia-Yang Lin <cylin0708@realtek.com>
parent 63623915

drivers/rtc/CMakeLists.txt

+1 −0
Changes for drivers/rtc/CMakeLists.txt: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -25,6 +25,7 @@ zephyr_library_sources_ifdef(CONFIG_RTC_SMARTBOND rtc_smartbond.c) 
zephyr_library_sources_ifdef(CONFIG_RTC_ATMEL_SAM rtc_sam.c)

zephyr_library_sources_ifdef(CONFIG_RTC_ATMEL_SAM0 rtc_sam0.c)

zephyr_library_sources_ifdef(CONFIG_RTC_RPI_PICO rtc_rpi_pico.c)

zephyr_library_sources_ifdef(CONFIG_RTC_RTS5912 rtc_rts5912.c)

zephyr_library_sources_ifdef(CONFIG_RTC_RV3028 rtc_rv3028.c)

zephyr_library_sources_ifdef(CONFIG_RTC_NUMAKER rtc_numaker.c)

zephyr_library_sources_ifdef(CONFIG_RTC_XMC4XXX rtc_xmc4xxx.c)

drivers/rtc/Kconfig

+1 −0
Changes for drivers/rtc/Kconfig: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -52,6 +52,7 @@ source "drivers/rtc/Kconfig.mc146818" 
source "drivers/rtc/Kconfig.pcf8523"

source "drivers/rtc/Kconfig.pcf8563"

source "drivers/rtc/Kconfig.rpi_pico"

source "drivers/rtc/Kconfig.rts5912"

source "drivers/rtc/Kconfig.rv3028"

source "drivers/rtc/Kconfig.sam"

source "drivers/rtc/Kconfig.sam0"

drivers/rtc/Kconfig.rts5912

0 → 100644
+10 −0
Changes for drivers/rtc/Kconfig.rts5912: 10 added lines, 0 removed lines.
Original line number Diff line number Diff line 
# Copyright (c) 2025, Realtek, SIBG-SD7

# SPDX-License-Identifier: Apache-2.0



config RTC_RTS5912

	bool "Realtek RTS5912 rtc driver"

	default y

	depends on CLOCK_CONTROL

	depends on DT_HAS_REALTEK_RTS5912_RTC_ENABLED

	help

	  Enable support for Realtek RTC driver.

drivers/rtc/rtc_rts5912.c

0 → 100644
+158 −0
Changes for drivers/rtc/rtc_rts5912.c: 158 added lines, 0 removed lines.
Original line number Diff line number Diff line 
/*

 * SPDX-License-Identifier: Apache-2.0

 *

 * Copyright (c) 2025 Realtek Semiconductor Corporation, SIBG-SD7

 * Author: Chia-Yang Lin <cylin0708@realtek.com>

 */



#define DT_DRV_COMPAT realtek_rts5912_rtc



#include <soc.h>

#include <errno.h>

#include <zephyr/device.h>

#include <zephyr/drivers/rtc.h>

#include <zephyr/kernel.h>

#include <zephyr/logging/log.h>

#include <zephyr/drivers/clock_control.h>

#include <zephyr/drivers/clock_control/clock_control_rts5912.h>

#include "rtc_utils.h"



#include "reg/reg_system.h"

#include "reg/reg_rtc.h"



LOG_MODULE_REGISTER(rtc_rts5912, CONFIG_RTC_LOG_LEVEL);



#define RTS5912_RTC_TIME_MASK                                                                      \

	(RTC_ALARM_TIME_MASK_SECOND | RTC_ALARM_TIME_MASK_MINUTE | RTC_ALARM_TIME_MASK_HOUR |      \

	 RTC_ALARM_TIME_MASK_WEEKDAY | RTC_ALARM_TIME_MASK_MONTHDAY | RTC_ALARM_TIME_MASK_MONTH |  \

	 RTC_ALARM_TIME_MASK_YEAR)



#define RTS5912_RTC_DIVCTL_NORMAL_OPERATION BIT(1)



#define RTS5912_RTC_DAYWEEK_OFFSET 1

#define RTS5912_RTC_MONTH_OFFSET   1

#define RTS5912_RTC_YEAR_OFFSET    100



struct rtc_rts5912_config {

	RTC_Type *regs;

	uint32_t rtc_base;

	uint32_t rtc_clk_grp;

	uint32_t rtc_clk_idx;

	const struct device *clk_dev;

};



struct rtc_rts5912_data {

	struct k_spinlock lock;

};



static void rtc_rts5912_reset_rtc_time(const struct device *dev)

{

	const struct rtc_rts5912_config *const dev_cfg = dev->config;

	RTC_Type *rtc_regs = dev_cfg->regs;



	rtc_regs->CTRL1 |= RTC_CTRL1_SETMODE_Msk;

	rtc_regs->CTRL0 &= ~RTC_CTRL0_DIVCTL_Msk;

	rtc_regs->CTRL0 |= (RTS5912_RTC_DIVCTL_NORMAL_OPERATION << RTC_CTRL0_DIVCTL_Pos);

	rtc_regs->CTRL1 |= RTC_CTRL1_DATEMODE_Msk;

	rtc_regs->CTRL1 |= RTC_CTRL1_HRMODE_Msk;

	rtc_regs->SEC = 0;

	rtc_regs->MIN = 0;

	rtc_regs->HR &= ~(RTC_HR_AMPM_Msk | RTC_HR_VAL_Msk);

	rtc_regs->DAYWEEK = BIT(0);

	rtc_regs->DAYMONTH = BIT(0);

	rtc_regs->MONTH = BIT(0);

	rtc_regs->YEAR = 0;

	rtc_regs->WEEK &= ~RTC_WEEK_NUM_Msk;

}



static int rtc_rts5912_set_time(const struct device *dev, const struct rtc_time *timeptr)

{

	const struct rtc_rts5912_config *const dev_cfg = dev->config;

	RTC_Type *rtc_regs = dev_cfg->regs;



	if (!rtc_utils_validate_rtc_time(timeptr, RTS5912_RTC_TIME_MASK)) {

		rtc_rts5912_reset_rtc_time(dev);

		k_msleep(1);

		return -EINVAL;

	}



	rtc_regs->CTRL1 |= RTC_CTRL1_SETMODE_Msk;

	rtc_regs->SEC = timeptr->tm_sec;

	rtc_regs->MIN = timeptr->tm_min;

	rtc_regs->HR = timeptr->tm_hour;

	rtc_regs->DAYWEEK = timeptr->tm_wday + RTS5912_RTC_DAYWEEK_OFFSET;

	rtc_regs->DAYMONTH = timeptr->tm_mday;

	rtc_regs->MONTH = timeptr->tm_mon + RTS5912_RTC_MONTH_OFFSET;

	rtc_regs->YEAR = timeptr->tm_year % RTS5912_RTC_YEAR_OFFSET;

	/* Need to delay in order to update register after setting RTC time */

	k_msleep(1);

	rtc_regs->CTRL1 &= ~RTC_CTRL1_SETMODE_Msk;



	return 0;

}



static int rtc_rts5912_get_time(const struct device *dev, struct rtc_time *timeptr)

{

	const struct rtc_rts5912_config *const dev_cfg = dev->config;

	RTC_Type *rtc_regs = dev_cfg->regs;



	timeptr->tm_sec = rtc_regs->SEC;

	timeptr->tm_min = rtc_regs->MIN;

	timeptr->tm_hour = rtc_regs->HR;

	timeptr->tm_wday = rtc_regs->DAYWEEK - RTS5912_RTC_DAYWEEK_OFFSET;

	timeptr->tm_mday = rtc_regs->DAYMONTH;

	timeptr->tm_mon = rtc_regs->MONTH - RTS5912_RTC_MONTH_OFFSET;

	timeptr->tm_year = rtc_regs->YEAR + RTS5912_RTC_YEAR_OFFSET;



	/* No support for daylight saving time flag and nanoseconds in rts5912 RTC */

	timeptr->tm_isdst = -1;

	timeptr->tm_nsec = 0;



	return 0;

}



static DEVICE_API(rtc, rtc_rts5912_driver_api) = {

	.set_time = rtc_rts5912_set_time,

	.get_time = rtc_rts5912_get_time,

};



static int rtc_rts5912_init(const struct device *dev)

{

	const struct rtc_rts5912_config *const rtc_config = dev->config;

	struct rts5912_sccon_subsys sccon;



	int rc;



	if (!device_is_ready(rtc_config->clk_dev)) {

		LOG_ERR("RTC device not ready");

		return -ENODEV;

	}



	sccon.clk_grp = rtc_config->rtc_clk_grp;

	sccon.clk_idx = rtc_config->rtc_clk_idx;

	rc = clock_control_on(rtc_config->clk_dev, (clock_control_subsys_t)&sccon);

	if (rc < 0) {

		LOG_ERR("Failed to turn on RTC clock (%d)", rc);

		return rc;

	}



	rtc_rts5912_reset_rtc_time(dev);



	return rc;

}



#define RTC_RTS5912_CONFIG(inst)                                                                   \

	static struct rtc_rts5912_config rtc_rts5912_config_##inst = {                             \

		.regs = (RTC_Type *)(DT_INST_REG_ADDR(inst)),                                      \

		.rtc_base = DT_INST_REG_ADDR(inst),                                                \

		.rtc_clk_grp = DT_INST_CLOCKS_CELL_BY_NAME(inst, rtc, clk_grp),                    \

		.rtc_clk_idx = DT_INST_CLOCKS_CELL_BY_NAME(inst, rtc, clk_idx),                    \

		.clk_dev = DEVICE_DT_GET(DT_INST_CLOCKS_CTLR(inst)),                               \

	};



#define RTC_RTS5912_DEVICE_INIT(index)                                                             \

	RTC_RTS5912_CONFIG(index)                                                                  \

	DEVICE_DT_INST_DEFINE(index, &rtc_rts5912_init, NULL, NULL, &rtc_rts5912_config_##index,   \

			      POST_KERNEL, CONFIG_RTC_INIT_PRIORITY, &rtc_rts5912_driver_api);



DT_INST_FOREACH_STATUS_OKAY(RTC_RTS5912_DEVICE_INIT)

dts/arm/realtek/ec/rts5912.dtsi

+8 −0
Changes for dts/arm/realtek/ec/rts5912.dtsi: 8 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -79,6 +79,14 @@ 
			clock-names = "rc25m", "pll";

		};



		rtc: rtc@4000c100 {

			compatible = "realtek,rts5912-rtc";

			reg = <0x4000c100 0x20>;

			clocks = <&sccon RTS5912_SCCON_PERIPH_GRP2 PERIPH_GRP2_RTC_CLKPWR>;

			clock-names = "rtc";

			status = "disabled";

		};



		slwtmr0: slwtmr0@4000c200 {

			compatible = "realtek,rts5912-slwtimer";

			reg = <0x4000c200 0x10>;

CRA Git | Maintained and supported by SUSTech CRA and CCSE