drivers/rtc/rtc-xgene.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * APM X-Gene SoC Real Time Clock Driver
   4  *
   5  * Copyright (c) 2014, Applied Micro Circuits Corporation
   6  * Author: Rameshwar Prasad Sahu <rsahu@apm.com>
   7  *         Loc Ho <lho@apm.com>
   8  */
   9
  10 #include <linux/clk.h>
  11 #include <linux/delay.h>
  12 #include <linux/init.h>
  13 #include <linux/io.h>
  14 #include <linux/module.h>
  15 #include <linux/of.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/rtc.h>
  18 #include <linux/slab.h>
  19
  20 /* RTC CSR Registers */
  21 #define RTC_CCVR                0x00
  22 #define RTC_CMR                 0x04
  23 #define RTC_CLR                 0x08
  24 #define RTC_CCR                 0x0C
  25 #define  RTC_CCR_IE             BIT(0)
  26 #define  RTC_CCR_MASK           BIT(1)
  27 #define  RTC_CCR_EN             BIT(2)
  28 #define  RTC_CCR_WEN            BIT(3)
  29 #define RTC_STAT                0x10
  30 #define  RTC_STAT_BIT           BIT(0)
  31 #define RTC_RSTAT               0x14
  32 #define RTC_EOI                 0x18
  33 #define RTC_VER                 0x1C
  34
  35 struct xgene_rtc_dev {
  36         struct rtc_device *rtc;
  37         struct device *dev;
  38         void __iomem *csr_base;
  39         struct clk *clk;
  40         unsigned int irq_wake;
  41         unsigned int irq_enabled;
  42 };
  43
  44 static int xgene_rtc_read_time(struct device *dev, struct rtc_time *tm)
  45 {
  46         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
  47
  48         rtc_time64_to_tm(readl(pdata->csr_base + RTC_CCVR), tm);
  49         return 0;
  50 }
  51
  52 static int xgene_rtc_set_time(struct device *dev, struct rtc_time *tm)
  53 {
  54         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
  55
  56         /*
  57          * NOTE: After the following write, the RTC_CCVR is only reflected
  58          *       after the update cycle of 1 seconds.
  59          */
  60         writel((u32)rtc_tm_to_time64(tm), pdata->csr_base + RTC_CLR);
  61         readl(pdata->csr_base + RTC_CLR); /* Force a barrier */
  62
  63         return 0;
  64 }
  65
  66 static int xgene_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
  67 {
  68         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
  69
  70         /* If possible, CMR should be read here */
  71         rtc_time64_to_tm(0, &alrm->time);
  72         alrm->enabled = readl(pdata->csr_base + RTC_CCR) & RTC_CCR_IE;
  73
  74         return 0;
  75 }
  76
  77 static int xgene_rtc_alarm_irq_enable(struct device *dev, u32 enabled)
  78 {
  79         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
  80         u32 ccr;
  81
  82         ccr = readl(pdata->csr_base + RTC_CCR);
  83         if (enabled) {
  84                 ccr &= ~RTC_CCR_MASK;
  85                 ccr |= RTC_CCR_IE;
  86         } else {
  87                 ccr &= ~RTC_CCR_IE;
  88                 ccr |= RTC_CCR_MASK;
  89         }
  90         writel(ccr, pdata->csr_base + RTC_CCR);
  91
  92         return 0;
  93 }
  94
  95 static int xgene_rtc_alarm_irq_enabled(struct device *dev)
  96 {
  97         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
  98
  99         return readl(pdata->csr_base + RTC_CCR) & RTC_CCR_IE ? 1 : 0;
 100 }
 101
 102 static int xgene_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 103 {
 104         struct xgene_rtc_dev *pdata = dev_get_drvdata(dev);
 105
 106         writel((u32)rtc_tm_to_time64(&alrm->time), pdata->csr_base + RTC_CMR);
 107
 108         xgene_rtc_alarm_irq_enable(dev, alrm->enabled);
 109
 110         return 0;
 111 }
 112
 113 static const struct rtc_class_ops xgene_rtc_ops = {
 114         .read_time      = xgene_rtc_read_time,
 115         .set_time       = xgene_rtc_set_time,
 116         .read_alarm     = xgene_rtc_read_alarm,
 117         .set_alarm      = xgene_rtc_set_alarm,
 118         .alarm_irq_enable = xgene_rtc_alarm_irq_enable,
 119 };
 120
 121 static irqreturn_t xgene_rtc_interrupt(int irq, void *id)
 122 {
 123         struct xgene_rtc_dev *pdata = id;
 124
 125         /* Check if interrupt asserted */
 126         if (!(readl(pdata->csr_base + RTC_STAT) & RTC_STAT_BIT))
 127                 return IRQ_NONE;
 128
 129         /* Clear interrupt */
 130         readl(pdata->csr_base + RTC_EOI);
 131
 132         rtc_update_irq(pdata->rtc, 1, RTC_IRQF | RTC_AF);
 133
 134         return IRQ_HANDLED;
 135 }
 136
 137 static int xgene_rtc_probe(struct platform_device *pdev)
 138 {
 139         struct xgene_rtc_dev *pdata;
 140         struct resource *res;
 141         int ret;
 142         int irq;
 143
 144         pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
 145         if (!pdata)
 146                 return -ENOMEM;
 147         platform_set_drvdata(pdev, pdata);
 148         pdata->dev = &pdev->dev;
 149
 150         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 151         pdata->csr_base = devm_ioremap_resource(&pdev->dev, res);
 152         if (IS_ERR(pdata->csr_base))
 153                 return PTR_ERR(pdata->csr_base);
 154
 155         pdata->rtc = devm_rtc_allocate_device(&pdev->dev);
 156         if (IS_ERR(pdata->rtc))
 157                 return PTR_ERR(pdata->rtc);
 158
 159         irq = platform_get_irq(pdev, 0);
 160         if (irq < 0)
 161                 return irq;
 162         ret = devm_request_irq(&pdev->dev, irq, xgene_rtc_interrupt, 0,
 163                                dev_name(&pdev->dev), pdata);
 164         if (ret) {
 165                 dev_err(&pdev->dev, "Could not request IRQ\n");
 166                 return ret;
 167         }
 168
 169         pdata->clk = devm_clk_get(&pdev->dev, NULL);
 170         if (IS_ERR(pdata->clk)) {
 171                 dev_err(&pdev->dev, "Couldn't get the clock for RTC\n");
 172                 return -ENODEV;
 173         }
 174         ret = clk_prepare_enable(pdata->clk);
 175         if (ret)
 176                 return ret;
 177
 178         /* Turn on the clock and the crystal */
 179         writel(RTC_CCR_EN, pdata->csr_base + RTC_CCR);
 180
 181         ret = device_init_wakeup(&pdev->dev, 1);
 182         if (ret) {
 183                 clk_disable_unprepare(pdata->clk);
 184                 return ret;
 185         }
 186
 187         /* HW does not support update faster than 1 seconds */
 188         pdata->rtc->uie_unsupported = 1;
 189         pdata->rtc->ops = &xgene_rtc_ops;
 190         pdata->rtc->range_max = U32_MAX;
 191
 192         ret = rtc_register_device(pdata->rtc);
 193         if (ret) {
 194                 clk_disable_unprepare(pdata->clk);
 195                 return ret;
 196         }
 197
 198         return 0;
 199 }
 200
 201 static int xgene_rtc_remove(struct platform_device *pdev)
 202 {
 203         struct xgene_rtc_dev *pdata = platform_get_drvdata(pdev);
 204
 205         xgene_rtc_alarm_irq_enable(&pdev->dev, 0);
 206         device_init_wakeup(&pdev->dev, 0);
 207         clk_disable_unprepare(pdata->clk);
 208         return 0;
 209 }
 210
 211 static int __maybe_unused xgene_rtc_suspend(struct device *dev)
 212 {
 213         struct platform_device *pdev = to_platform_device(dev);
 214         struct xgene_rtc_dev *pdata = platform_get_drvdata(pdev);
 215         int irq;
 216
 217         irq = platform_get_irq(pdev, 0);
 218
 219         /*
 220          * If this RTC alarm will be used for waking the system up,
 221          * don't disable it of course. Else we just disable the alarm
 222          * and await suspension.
 223          */
 224         if (device_may_wakeup(&pdev->dev)) {
 225                 if (!enable_irq_wake(irq))
 226                         pdata->irq_wake = 1;
 227         } else {
 228                 pdata->irq_enabled = xgene_rtc_alarm_irq_enabled(dev);
 229                 xgene_rtc_alarm_irq_enable(dev, 0);
 230                 clk_disable_unprepare(pdata->clk);
 231         }
 232         return 0;
 233 }
 234
 235 static int __maybe_unused xgene_rtc_resume(struct device *dev)
 236 {
 237         struct platform_device *pdev = to_platform_device(dev);
 238         struct xgene_rtc_dev *pdata = platform_get_drvdata(pdev);
 239         int irq;
 240         int rc;
 241
 242         irq = platform_get_irq(pdev, 0);
 243
 244         if (device_may_wakeup(&pdev->dev)) {
 245                 if (pdata->irq_wake) {
 246                         disable_irq_wake(irq);
 247                         pdata->irq_wake = 0;
 248                 }
 249         } else {
 250                 rc = clk_prepare_enable(pdata->clk);
 251                 if (rc) {
 252                         dev_err(dev, "Unable to enable clock error %d\n", rc);
 253                         return rc;
 254                 }
 255                 xgene_rtc_alarm_irq_enable(dev, pdata->irq_enabled);
 256         }
 257
 258         return 0;
 259 }
 260
 261 static SIMPLE_DEV_PM_OPS(xgene_rtc_pm_ops, xgene_rtc_suspend, xgene_rtc_resume);
 262
 263 #ifdef CONFIG_OF
 264 static const struct of_device_id xgene_rtc_of_match[] = {
 265         {.compatible = "apm,xgene-rtc" },
 266         { }
 267 };
 268 MODULE_DEVICE_TABLE(of, xgene_rtc_of_match);
 269 #endif
 270
 271 static struct platform_driver xgene_rtc_driver = {
 272         .probe          = xgene_rtc_probe,
 273         .remove         = xgene_rtc_remove,
 274         .driver         = {
 275                 .name   = "xgene-rtc",
 276                 .pm = &xgene_rtc_pm_ops,
 277                 .of_match_table = of_match_ptr(xgene_rtc_of_match),
 278         },
 279 };
 280
 281 module_platform_driver(xgene_rtc_driver);
 282
 283 MODULE_DESCRIPTION("APM X-Gene SoC RTC driver");
 284 MODULE_AUTHOR("Rameshwar Sahu <rsahu@apm.com>");
 285 MODULE_LICENSE("GPL");