^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Faraday Technology FTRTC010 driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2009 Janos Laube <janos.dev@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Original code for older kernel 2.6.15 are from Stormlinksemi
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * first update from Janos Laube for > 2.6.29 kernels
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * checkpatch fixes and usage of rtc-lib code
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * Hans Ulli Kroll <ulli.kroll@googlemail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/rtc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/io.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/platform_device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include <linux/mod_devicetable.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #include <linux/clk.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define DRV_NAME "rtc-ftrtc010"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) MODULE_AUTHOR("Hans Ulli Kroll <ulli.kroll@googlemail.com>");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) MODULE_DESCRIPTION("RTC driver for Gemini SoC");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) MODULE_LICENSE("GPL");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) MODULE_ALIAS("platform:" DRV_NAME);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct ftrtc010_rtc {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) struct rtc_device *rtc_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) void __iomem *rtc_base;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) int rtc_irq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) struct clk *pclk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) struct clk *extclk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) enum ftrtc010_rtc_offsets {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) FTRTC010_RTC_SECOND = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) FTRTC010_RTC_MINUTE = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) FTRTC010_RTC_HOUR = 0x08,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) FTRTC010_RTC_DAYS = 0x0C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) FTRTC010_RTC_ALARM_SECOND = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) FTRTC010_RTC_ALARM_MINUTE = 0x14,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) FTRTC010_RTC_ALARM_HOUR = 0x18,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) FTRTC010_RTC_RECORD = 0x1C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) FTRTC010_RTC_CR = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) static irqreturn_t ftrtc010_rtc_interrupt(int irq, void *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) return IRQ_HANDLED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * Looks like the RTC in the Gemini SoC is (totaly) broken
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * We can't read/write directly the time from RTC registers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) * We must do some "offset" calculation to get the real time
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * This FIX works pretty fine and Stormlinksemi aka Cortina-Networks does
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) * the same thing, without the rtc-lib.c calls.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) static int ftrtc010_rtc_read_time(struct device *dev, struct rtc_time *tm)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) u32 days, hour, min, sec, offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) timeu64_t time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) offset = readl(rtc->rtc_base + FTRTC010_RTC_RECORD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) time = offset + days * 86400 + hour * 3600 + min * 60 + sec;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) rtc_time64_to_tm(time, tm);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) static int ftrtc010_rtc_set_time(struct device *dev, struct rtc_time *tm)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) struct ftrtc010_rtc *rtc = dev_get_drvdata(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) u32 sec, min, hour, day, offset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) timeu64_t time;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) time = rtc_tm_to_time64(tm);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) day = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) offset = time - (day * 86400 + hour * 3600 + min * 60 + sec);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) writel(offset, rtc->rtc_base + FTRTC010_RTC_RECORD);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) writel(0x01, rtc->rtc_base + FTRTC010_RTC_CR);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) static const struct rtc_class_ops ftrtc010_rtc_ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) .read_time = ftrtc010_rtc_read_time,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) .set_time = ftrtc010_rtc_set_time,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) static int ftrtc010_rtc_probe(struct platform_device *pdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) u32 days, hour, min, sec;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) struct ftrtc010_rtc *rtc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) struct device *dev = &pdev->dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) struct resource *res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) rtc = devm_kzalloc(&pdev->dev, sizeof(*rtc), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) if (unlikely(!rtc))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) platform_set_drvdata(pdev, rtc);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) rtc->pclk = devm_clk_get(dev, "PCLK");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) if (IS_ERR(rtc->pclk)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) dev_err(dev, "could not get PCLK\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) ret = clk_prepare_enable(rtc->pclk);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) dev_err(dev, "failed to enable PCLK\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) rtc->extclk = devm_clk_get(dev, "EXTCLK");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) if (IS_ERR(rtc->extclk)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) dev_err(dev, "could not get EXTCLK\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) ret = clk_prepare_enable(rtc->extclk);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) if (ret) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) dev_err(dev, "failed to enable EXTCLK\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) if (!res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) rtc->rtc_irq = res->start;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) if (!res)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) return -ENODEV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) rtc->rtc_base = devm_ioremap(dev, res->start,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) resource_size(res));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) if (!rtc->rtc_base)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) rtc->rtc_dev = devm_rtc_allocate_device(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) if (IS_ERR(rtc->rtc_dev))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) return PTR_ERR(rtc->rtc_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) rtc->rtc_dev->ops = &ftrtc010_rtc_ops;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) sec = readl(rtc->rtc_base + FTRTC010_RTC_SECOND);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) min = readl(rtc->rtc_base + FTRTC010_RTC_MINUTE);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) hour = readl(rtc->rtc_base + FTRTC010_RTC_HOUR);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) days = readl(rtc->rtc_base + FTRTC010_RTC_DAYS);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) rtc->rtc_dev->range_min = (u64)days * 86400 + hour * 3600 +
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) min * 60 + sec;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) rtc->rtc_dev->range_max = U32_MAX + rtc->rtc_dev->range_min;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) ret = devm_request_irq(dev, rtc->rtc_irq, ftrtc010_rtc_interrupt,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) IRQF_SHARED, pdev->name, dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) if (unlikely(ret))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) return rtc_register_device(rtc->rtc_dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) static int ftrtc010_rtc_remove(struct platform_device *pdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) struct ftrtc010_rtc *rtc = platform_get_drvdata(pdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) if (!IS_ERR(rtc->extclk))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) clk_disable_unprepare(rtc->extclk);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) if (!IS_ERR(rtc->pclk))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) clk_disable_unprepare(rtc->pclk);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) static const struct of_device_id ftrtc010_rtc_dt_match[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) { .compatible = "cortina,gemini-rtc" },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) { .compatible = "faraday,ftrtc010" },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) MODULE_DEVICE_TABLE(of, ftrtc010_rtc_dt_match);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) static struct platform_driver ftrtc010_rtc_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) .driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) .name = DRV_NAME,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) .of_match_table = ftrtc010_rtc_dt_match,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206) .probe = ftrtc010_rtc_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) .remove = ftrtc010_rtc_remove,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) module_platform_driver_probe(ftrtc010_rtc_driver, ftrtc010_rtc_probe);