[PATCH V4 RESEND 1/3] rtc: atcrtc100: Add ATCRTC100 RTC driver
From: CL Wang
Date: Thu Nov 14 2024 - 08:43:57 EST
RTC driver for Andes ATCRTC100 Real-Time Clock.
Signed-off-by: CL Wang <cl634@xxxxxxxxxxxxx>
---
Changes for v1:
- Initial version of the ATCRTC100 driver.
Changes for v2:
- Replaced legacy APIs with devm APIs for system resource allocation.
- Used regmap APIs to access I/O registers.
Changes for v3:
- Removed 'of_match_ptr()'.
- Added check for WriteDone status before accessing Counter, Alarm, and Control registers.
Changes for v4:
- Refined the procedure for setting the wake-up source.
- Fixed coding style to comply with Linux coding style guidelines.
---
drivers/rtc/Kconfig | 15 ++
drivers/rtc/Makefile | 1 +
drivers/rtc/rtc-atcrtc100.c | 524 ++++++++++++++++++++++++++++++++++++
3 files changed, 540 insertions(+)
create mode 100644 drivers/rtc/rtc-atcrtc100.c
diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig
index 66eb1122248b..253c64dee5bb 100644
--- a/drivers/rtc/Kconfig
+++ b/drivers/rtc/Kconfig
@@ -1029,6 +1029,21 @@ config RTC_DRV_ALPHA
Direct support for the real-time clock found on every Alpha
system, specifically MC146818 compatibles. If in doubt, say Y.
+config RTC_DRV_ATCRTC100
+ tristate "Andes ATCRTC100"
+ depends on RISCV
+ select REGMAP_MMIO
+ help
+ If you say yes here you will get support for the Andes ATCRTC100
+ RTC driver.
+
+ This driver provides support for the Andes ATCRTC100 real-time clock
+ device. It allows setting and retrieving the time and date, as well
+ as setting alarms.
+
+ To compile this driver as a module, choose M here: the module will
+ be called rtc-atcrtc100.
+
config RTC_DRV_DS1216
tristate "Dallas DS1216"
depends on SNI_RM
diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile
index f62340ecc534..c19dd68cc9da 100644
--- a/drivers/rtc/Makefile
+++ b/drivers/rtc/Makefile
@@ -32,6 +32,7 @@ obj-$(CONFIG_RTC_DRV_ASM9260) += rtc-asm9260.o
obj-$(CONFIG_RTC_DRV_ASPEED) += rtc-aspeed.o
obj-$(CONFIG_RTC_DRV_AT91RM9200)+= rtc-at91rm9200.o
obj-$(CONFIG_RTC_DRV_AT91SAM9) += rtc-at91sam9.o
+obj-$(CONFIG_RTC_DRV_ATCRTC100) += rtc-atcrtc100.o
obj-$(CONFIG_RTC_DRV_AU1XXX) += rtc-au1xxx.o
obj-$(CONFIG_RTC_DRV_BBNSM) += rtc-nxp-bbnsm.o
obj-$(CONFIG_RTC_DRV_BD70528) += rtc-bd70528.o
diff --git a/drivers/rtc/rtc-atcrtc100.c b/drivers/rtc/rtc-atcrtc100.c
new file mode 100644
index 000000000000..40629f796f3b
--- /dev/null
+++ b/drivers/rtc/rtc-atcrtc100.c
@@ -0,0 +1,524 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Driver for Andes ATCRTC100 real time clock.
+ *
+ * Copyright (C) 2024 Andes Technology Corporation
+ */
+
+#include <linux/module.h>
+#include <linux/rtc.h>
+#include <linux/platform_device.h>
+#include <linux/interrupt.h>
+#include <linux/of.h>
+#include <linux/regmap.h>
+#include <linux/pm_wakeirq.h>
+#include <linux/delay.h>
+#include <linux/workqueue.h>
+
+#define RTC_ID 0x00 /* ID and Revision */
+#define ID_OFF 12
+#define ID_MSK (0xFFFFF << ID_OFF)
+#define ATCRTC100ID (0x03011 << ID_OFF)
+#define RTC_RSV 0x4 /* Reserve */
+#define RTC_CNT 0x10 /* Counter */
+#define RTC_ALM 0x14 /* Alarm */
+#define DAY_OFF 17
+#define DAY_MSK 0x7FFF
+#define HOUR_OFF 12
+#define HOUR_MSK 0x1F
+#define MIN_OFF 6
+#define MIN_MSK 0x3F
+#define SEC_OFF 0
+#define SEC_MSK 0x3F
+#define RTC_SECOND(x) ((x >> SEC_OFF) & SEC_MSK) /* RTC sec */
+#define RTC_MINUTE(x) ((x >> MIN_OFF) & MIN_MSK) /* RTC min */
+#define RTC_HOUR(x) ((x >> HOUR_OFF) & HOUR_MSK) /* RTC hour */
+#define RTC_DAYS(x) ((x >> DAY_OFF) & DAY_MSK) /* RTC day */
+
+#define RTC_CR 0x18 /* Control */
+#define RTC_EN (0x1UL << 0)
+#define ALARM_WAKEUP (0x1UL << 1)
+#define ALARM_INT (0x1UL << 2)
+#define DAY_INT (0x1UL << 3)
+#define HOUR_INT (0x1UL << 4)
+#define MIN_INT (0x1UL << 5)
+#define SEC_INT (0x1UL << 6)
+#define HSEC_INT (0x1UL << 7)
+#define RTC_STA 0x1C /* Status */
+#define WRITE_DONE (0x1UL << 16)
+#define RTC_TRIM 0x20 /* Digital Trimming */
+
+#define ATCRTC_TIME_TO_SEC(D, H, M, S) (D * 86400LL + H * 3600 + M * 60 + S)
+
+#define ATCRTC_TIMEOUT_US 1000000
+#define ATCRTC_TIMEOUT_USLEEP_MIN 20
+#define ATCRTC_TIMEOUT_USLEEP_MAX 30
+
+struct atcrtc_dev {
+ struct rtc_device *rtc_dev;
+ struct regmap *regmap;
+ struct delayed_work rtc_work;
+ struct mutex lock;
+ unsigned int alarm_irq;
+ unsigned int time_irq;
+ unsigned char alarm_en;
+};
+
+static const struct regmap_config atcrtc_regmap_config = {
+ .reg_bits = 32,
+ .reg_stride = 4,
+ .val_bits = 32,
+ .max_register = RTC_TRIM,
+ .cache_type = REGCACHE_NONE,
+};
+
+/**
+ * atcrtc_check_write_done - Check whether the ATCRTC100 is ready or not.
+ * @rtc: Pointer of atcrtc_dev.
+ *
+ * The WriteDone bit in the status register indicates the synchronization
+ * progress of RTC register updates. This bit is cleared to zero whenever
+ * any RTC control register such as the Counter, Alarm, Control, or Digital
+ * Trimming registers is updated. It returns to one only after all previous
+ * updates to these registers have been fully synchronized to the RTC clock
+ * domain. If a register update is in the process of being synchronized, a
+ * second update to the same register may be ignored.
+ */
+static int atcrtc_check_write_done(struct atcrtc_dev *rtc)
+{
+ int loop;
+ int timeout;
+
+ might_sleep();
+ timeout = ATCRTC_TIMEOUT_US / ATCRTC_TIMEOUT_USLEEP_MIN;
+
+ for (loop = 0; loop < timeout; loop++) {
+ if (regmap_test_bits(rtc->regmap, RTC_STA, WRITE_DONE))
+ return 0;
+
+ usleep_range(ATCRTC_TIMEOUT_USLEEP_MIN,
+ ATCRTC_TIMEOUT_USLEEP_MAX);
+ }
+ dev_err(&rtc->rtc_dev->dev, "Device is busy too long\n");
+ return -EBUSY;
+}
+
+static irqreturn_t atcrtc_periodic_isr(int irq, void *dev)
+{
+ struct atcrtc_dev *rtc = dev;
+
+ if (regmap_test_bits(rtc->regmap, RTC_STA, SEC_INT)) {
+ regmap_write_bits(rtc->regmap, RTC_STA, SEC_INT, SEC_INT);
+ rtc_update_irq(rtc->rtc_dev, 1, RTC_UF | RTC_IRQF);
+ return IRQ_HANDLED;
+ }
+ return IRQ_NONE;
+}
+
+static irqreturn_t atcrtc_alarm_isr(int irq, void *dev)
+{
+ struct atcrtc_dev *rtc = dev;
+
+ if (regmap_test_bits(rtc->regmap, RTC_STA, ALARM_INT)) {
+ regmap_write_bits(rtc->regmap, RTC_STA, ALARM_INT, ALARM_INT);
+ rtc->alarm_en = 0;
+ schedule_delayed_work(&rtc->rtc_work, 0);
+ rtc_update_irq(rtc->rtc_dev, 1, RTC_AF | RTC_IRQF);
+ return IRQ_HANDLED;
+ }
+ return IRQ_NONE;
+}
+
+static int atcrtc_alarm_irq_enable(struct device *dev, unsigned int enable)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ int ret;
+
+ mutex_lock(&rtc->lock);
+
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return ret;
+ }
+
+ if (enable)
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_INT, ALARM_INT);
+ else
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_INT, 0);
+
+ mutex_unlock(&rtc->lock);
+
+ return 0;
+}
+
+static int atcrtc_alarm_enable(struct device *dev, unsigned int enable)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ int ret;
+
+ mutex_lock(&rtc->lock);
+
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return ret;
+ }
+
+ if (enable) {
+ regmap_update_bits(rtc->regmap,
+ RTC_CR,
+ ALARM_WAKEUP,
+ ALARM_WAKEUP);
+ } else {
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_WAKEUP, 0);
+ }
+
+ mutex_unlock(&rtc->lock);
+
+ return 0;
+}
+
+static void atcrtc_alarm_clear(struct work_struct *work)
+{
+ struct atcrtc_dev *rtc =
+ container_of(work, struct atcrtc_dev, rtc_work.work);
+ int ret;
+
+ mutex_lock(&rtc->lock);
+ if (rtc->alarm_en == 0) {
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return;
+ }
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_INT, 0);
+ }
+ mutex_unlock(&rtc->lock);
+}
+
+static time64_t atcrtc_read_rtc_time(struct atcrtc_dev *rtc)
+{
+ time64_t time;
+ unsigned int rtc_cnt;
+
+ regmap_read(rtc->regmap, RTC_CNT, &rtc_cnt);
+ time = ATCRTC_TIME_TO_SEC(RTC_DAYS(rtc_cnt),
+ RTC_HOUR(rtc_cnt),
+ RTC_MINUTE(rtc_cnt),
+ RTC_SECOND(rtc_cnt));
+ return time;
+}
+
+static int atcrtc_read_time(struct device *dev, struct rtc_time *tm)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ time64_t time;
+
+ mutex_lock(&rtc->lock);
+ time = atcrtc_read_rtc_time(rtc);
+ mutex_unlock(&rtc->lock);
+
+ rtc_time64_to_tm(time, tm);
+ if (rtc_valid_tm(tm) < 0) {
+ dev_err(dev, "Invalid date: %lld\n", time);
+ rtc_time64_to_tm(0, tm);
+ }
+ return 0;
+}
+
+static void atcrtc_set_rtc_time(struct atcrtc_dev *rtc, time64_t time)
+{
+ int rem;
+ unsigned int counter;
+ unsigned int day;
+ unsigned int hour;
+ unsigned int min;
+ unsigned int sec;
+
+ day = div_s64_rem(time, 86400, &rem);
+ hour = rem / 3600;
+ rem -= hour * 3600;
+ min = rem / 60;
+ sec = rem - min * 60;
+ counter = ((day & DAY_MSK) << DAY_OFF)
+ | ((hour & HOUR_MSK) << HOUR_OFF)
+ | ((min & MIN_MSK) << MIN_OFF)
+ | ((sec & SEC_MSK) << SEC_OFF);
+
+ regmap_write(rtc->regmap, RTC_CNT, counter);
+}
+
+static int atcrtc_set_time(struct device *dev, struct rtc_time *tm)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ time64_t sys_time;
+ int ret;
+
+ sys_time = rtc_tm_to_time64(tm);
+
+ mutex_lock(&rtc->lock);
+
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return ret;
+ }
+ atcrtc_set_rtc_time(rtc, sys_time);
+
+ mutex_unlock(&rtc->lock);
+
+ return 0;
+}
+
+static int atcrtc_read_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ struct rtc_time *tm = &wkalrm->time;
+ unsigned int rtc_alarm;
+
+ mutex_lock(&rtc->lock);
+
+ regmap_read(rtc->regmap, RTC_ALM, &rtc_alarm);
+ wkalrm->enabled = regmap_test_bits(rtc->regmap, RTC_CR, ALARM_INT);
+
+ mutex_unlock(&rtc->lock);
+
+ tm->tm_hour = (rtc_alarm >> HOUR_OFF) & HOUR_MSK;
+ tm->tm_min = (rtc_alarm >> MIN_OFF) & MIN_MSK;
+ tm->tm_sec = (rtc_alarm >> SEC_OFF) & SEC_MSK;
+
+ return 0;
+}
+
+static int atcrtc_set_alarm(struct device *dev, struct rtc_wkalrm *wkalrm)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+ struct rtc_time *tm = &wkalrm->time;
+ unsigned int alm = 0;
+ int ret = rtc_valid_tm(tm);
+
+ if (ret < 0) {
+ dev_err(dev, "Invalid alarm value: %d\n", ret);
+ return ret;
+ }
+
+ mutex_lock(&rtc->lock);
+
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return ret;
+ }
+
+ /* Disable alarm interrupt and clear the alarm flag */
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_INT, 0);
+ rtc->alarm_en = 0;
+
+ /* Set alarm time */
+ alm |= ((tm->tm_sec & SEC_MSK) << SEC_OFF);
+ alm |= ((tm->tm_min & MIN_MSK) << MIN_OFF);
+ alm |= ((tm->tm_hour & HOUR_MSK) << HOUR_OFF);
+ regmap_write(rtc->regmap, RTC_ALM, alm);
+
+ if (wkalrm->enabled) {
+ rtc->alarm_en = 1;
+ ret = atcrtc_check_write_done(rtc);
+ if (ret) {
+ mutex_unlock(&rtc->lock);
+ return ret;
+ }
+
+ regmap_update_bits(rtc->regmap, RTC_CR, ALARM_INT, ALARM_INT);
+ }
+
+ mutex_unlock(&rtc->lock);
+ return 0;
+}
+
+static int atcrtc_hw_init(struct atcrtc_dev *rtc)
+{
+ unsigned int rtc_id;
+ int ret;
+
+ regmap_read(rtc->regmap, RTC_ID, &rtc_id);
+ if ((rtc_id & ID_MSK) != ATCRTC100ID)
+ return -ENOENT;
+
+ ret = atcrtc_check_write_done(rtc);
+ if (ret)
+ return ret;
+ regmap_update_bits(rtc->regmap, RTC_CR, RTC_EN, RTC_EN);
+
+ return 0;
+}
+
+static const struct rtc_class_ops rtc_ops = {
+ .read_time = atcrtc_read_time,
+ .set_time = atcrtc_set_time,
+ .read_alarm = atcrtc_read_alarm,
+ .set_alarm = atcrtc_set_alarm,
+ .alarm_irq_enable = atcrtc_alarm_irq_enable,
+};
+
+static int atcrtc_probe(struct platform_device *pdev)
+{
+ struct atcrtc_dev *atcrtc_dev;
+ void __iomem *reg_base;
+ int ret = 0;
+
+ atcrtc_dev = devm_kzalloc(&pdev->dev, sizeof(*atcrtc_dev), GFP_KERNEL);
+ if (!atcrtc_dev)
+ return -ENOMEM;
+ platform_set_drvdata(pdev, atcrtc_dev);
+ mutex_init(&atcrtc_dev->lock);
+
+ reg_base = devm_platform_ioremap_resource(pdev, 0);
+ if (IS_ERR(reg_base)) {
+ dev_err(&pdev->dev,
+ "Failed to map I/O space: %ld\n",
+ PTR_ERR(reg_base));
+ return PTR_ERR(atcrtc_dev->regmap);
+ }
+
+ atcrtc_dev->regmap = devm_regmap_init_mmio(&pdev->dev,
+ reg_base,
+ &atcrtc_regmap_config);
+ if (IS_ERR(atcrtc_dev->regmap)) {
+ dev_err(&pdev->dev,
+ "Failed to initialize regmap: %ld\n",
+ PTR_ERR(atcrtc_dev->regmap));
+ return PTR_ERR(atcrtc_dev->regmap);
+ }
+
+ ret = atcrtc_hw_init(atcrtc_dev);
+ if (ret) {
+ dev_err(&pdev->dev, "Failed to initialize driver: %d\n", ret);
+ return ret;
+ }
+
+ atcrtc_dev->alarm_irq = platform_get_irq(pdev, 1);
+ if (atcrtc_dev->alarm_irq < 0) {
+ dev_err(&pdev->dev,
+ "Failed to get IRQ for alarm: %d\n",
+ atcrtc_dev->alarm_irq);
+ return atcrtc_dev->alarm_irq;
+ }
+ atcrtc_dev->time_irq = platform_get_irq(pdev, 0);
+ if (atcrtc_dev->time_irq < 0) {
+ dev_err(&pdev->dev,
+ "Failed to get IRQ for periodic interrupt: %d\n",
+ atcrtc_dev->time_irq);
+ return atcrtc_dev->time_irq;
+ }
+
+ ret = devm_request_irq(&pdev->dev,
+ atcrtc_dev->alarm_irq,
+ atcrtc_alarm_isr,
+ 0,
+ "atcrtc alarm",
+ atcrtc_dev);
+ if (ret) {
+ dev_err(&pdev->dev,
+ "Failed to request IRQ %d for alarm: %d\n",
+ atcrtc_dev->alarm_irq,
+ ret);
+ return ret;
+ }
+
+ ret = devm_request_irq(&pdev->dev,
+ atcrtc_dev->time_irq,
+ atcrtc_periodic_isr,
+ 0,
+ "atcrtc time",
+ atcrtc_dev);
+ if (ret) {
+ dev_err(&pdev->dev,
+ "Failed to request IRQ %d for periodic interrupt: %d\n",
+ atcrtc_dev->time_irq,
+ ret);
+ return ret;
+ }
+
+ atcrtc_dev->rtc_dev = devm_rtc_allocate_device(&pdev->dev);
+ if (IS_ERR(atcrtc_dev->rtc_dev)) {
+ dev_err(&pdev->dev,
+ "Failed to allocate RTC device: %ld\n",
+ PTR_ERR(atcrtc_dev->rtc_dev));
+ return PTR_ERR(atcrtc_dev->rtc_dev);
+ }
+
+ ret = atcrtc_alarm_enable(&pdev->dev, true);
+ if (ret)
+ return ret;
+ set_bit(RTC_FEATURE_ALARM, atcrtc_dev->rtc_dev->features);
+
+ ret = device_init_wakeup(&pdev->dev, true);
+ if (ret) {
+ dev_err(&pdev->dev,
+ "Failed to initialize wake device: %d\n",
+ ret);
+ return ret;
+ }
+
+ ret = dev_pm_set_wake_irq(&pdev->dev, atcrtc_dev->alarm_irq);
+ if (ret) {
+ dev_err(&pdev->dev, "Failed to set wake IRQ: %d\n", ret);
+ device_init_wakeup(&pdev->dev, false);
+ return ret;
+ }
+
+ atcrtc_dev->rtc_dev->ops = &rtc_ops;
+ /*
+ * There are 15 bits in the Day field of the Counter register.
+ * It can count up to 32,767 days, about 89.8 years.
+ */
+ atcrtc_dev->rtc_dev->range_max = mktime64(2089, 12, 31, 23, 59, 59);
+ atcrtc_dev->rtc_dev->range_min = RTC_TIMESTAMP_BEGIN_2000;
+
+ INIT_DELAYED_WORK(&atcrtc_dev->rtc_work, atcrtc_alarm_clear);
+ return devm_rtc_register_device(atcrtc_dev->rtc_dev);
+}
+
+static int atcrtc_resume(struct device *dev)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+
+ if (device_may_wakeup(dev))
+ disable_irq_wake(rtc->alarm_irq);
+
+ return 0;
+}
+
+static int atcrtc_suspend(struct device *dev)
+{
+ struct atcrtc_dev *rtc = dev_get_drvdata(dev);
+
+ if (device_may_wakeup(dev))
+ enable_irq_wake(rtc->alarm_irq);
+
+ return 0;
+}
+
+static DEFINE_SIMPLE_DEV_PM_OPS(atcrtc_pm_ops, atcrtc_suspend, atcrtc_resume);
+
+static const struct of_device_id atcrtc_dt_match[] = {
+ { .compatible = "andestech,atcrtc100" },
+ { }
+};
+MODULE_DEVICE_TABLE(of, atcrtc_dt_match);
+
+static struct platform_driver atcrtc_platform_driver = {
+ .driver = {
+ .name = "atcrtc100",
+ .of_match_table = atcrtc_dt_match,
+ .pm = pm_sleep_ptr(&atcrtc_pm_ops),
+ },
+ .probe = atcrtc_probe,
+};
+
+module_platform_driver(atcrtc_platform_driver);
+
+MODULE_AUTHOR("CL Wang <cl634@xxxxxxxxxxxxx>");
+MODULE_DESCRIPTION("Andes ATCRTC100 driver");
+MODULE_LICENSE("GPL");
--
2.34.1