drivers/rtc/rtc-at91sam9.c

   1 /*
   2  * "RTT as Real Time Clock" driver for AT91SAM9 SoC family
   3  *
   4  * (C) 2007 Michel Benoit
   5  *
   6  * Based on rtc-at91rm9200.c by Rick Bronson
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version
  11  * 2 of the License, or (at your option) any later version.
  12  */
  13
  14 #include <linux/clk.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/ioctl.h>
  17 #include <linux/io.h>
  18 #include <linux/kernel.h>
  19 #include <linux/mfd/syscon.h>
  20 #include <linux/module.h>
  21 #include <linux/of.h>
  22 #include <linux/platform_data/atmel.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/regmap.h>
  25 #include <linux/rtc.h>
  26 #include <linux/slab.h>
  27 #include <linux/suspend.h>
  28 #include <linux/time.h>
  29
  30 /*
  31  * This driver uses two configurable hardware resources that live in the
  32  * AT91SAM9 backup power domain (intended to be powered at all times)
  33  * to implement the Real Time Clock interfaces
  34  *
  35  *  - A "Real-time Timer" (RTT) counts up in seconds from a base time.
  36  *    We can't assign the counter value (CRTV) ... but we can reset it.
  37  *
  38  *  - One of the "General Purpose Backup Registers" (GPBRs) holds the
  39  *    base time, normally an offset from the beginning of the POSIX
  40  *    epoch (1970-Jan-1 00:00:00 UTC).  Some systems also include the
  41  *    local timezone's offset.
  42  *
  43  * The RTC's value is the RTT counter plus that offset.  The RTC's alarm
  44  * is likewise a base (ALMV) plus that offset.
  45  *
  46  * Not all RTTs will be used as RTCs; some systems have multiple RTTs to
  47  * choose from, or a "real" RTC module.  All systems have multiple GPBR
  48  * registers available, likewise usable for more than "RTC" support.
  49  */
  50
  51 #define AT91_RTT_MR             0x00                    /* Real-time Mode Register */
  52 #define AT91_RTT_RTPRES         (0xffff << 0)           /* Real-time Timer Prescaler Value */
  53 #define AT91_RTT_ALMIEN         (1 << 16)               /* Alarm Interrupt Enable */
  54 #define AT91_RTT_RTTINCIEN      (1 << 17)               /* Real Time Timer Increment Interrupt Enable */
  55 #define AT91_RTT_RTTRST         (1 << 18)               /* Real Time Timer Restart */
  56
  57 #define AT91_RTT_AR             0x04                    /* Real-time Alarm Register */
  58 #define AT91_RTT_ALMV           (0xffffffff)            /* Alarm Value */
  59
  60 #define AT91_RTT_VR             0x08                    /* Real-time Value Register */
  61 #define AT91_RTT_CRTV           (0xffffffff)            /* Current Real-time Value */
  62
  63 #define AT91_RTT_SR             0x0c                    /* Real-time Status Register */
  64 #define AT91_RTT_ALMS           (1 << 0)                /* Real-time Alarm Status */
  65 #define AT91_RTT_RTTINC         (1 << 1)                /* Real-time Timer Increment */
  66
  67 /*
  68  * We store ALARM_DISABLED in ALMV to record that no alarm is set.
  69  * It's also the reset value for that field.
  70  */
  71 #define ALARM_DISABLED  ((u32)~0)
  72
  73
  74 struct sam9_rtc {
  75         void __iomem            *rtt;
  76         struct rtc_device       *rtcdev;
  77         u32                     imr;
  78         struct regmap           *gpbr;
  79         unsigned int            gpbr_offset;
  80         int                     irq;
  81         struct clk              *sclk;
  82         bool                    suspended;
  83         unsigned long           events;
  84         spinlock_t              lock;
  85 };
  86
  87 #define rtt_readl(rtc, field) \
  88         readl((rtc)->rtt + AT91_RTT_ ## field)
  89 #define rtt_writel(rtc, field, val) \
  90         writel((val), (rtc)->rtt + AT91_RTT_ ## field)
  91
  92 static inline unsigned int gpbr_readl(struct sam9_rtc *rtc)
  93 {
  94         unsigned int val;
  95
  96         regmap_read(rtc->gpbr, rtc->gpbr_offset, &val);
  97
  98         return val;
  99 }
 100
 101 static inline void gpbr_writel(struct sam9_rtc *rtc, unsigned int val)
 102 {
 103         regmap_write(rtc->gpbr, rtc->gpbr_offset, val);
 104 }
 105
 106 /*
 107  * Read current time and date in RTC
 108  */
 109 static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
 110 {
 111         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 112         u32 secs, secs2;
 113         u32 offset;
 114
 115         /* read current time offset */
 116         offset = gpbr_readl(rtc);
 117         if (offset == 0)
 118                 return -EILSEQ;
 119
 120         /* reread the counter to help sync the two clock domains */
 121         secs = rtt_readl(rtc, VR);
 122         secs2 = rtt_readl(rtc, VR);
 123         if (secs != secs2)
 124                 secs = rtt_readl(rtc, VR);
 125
 126         rtc_time_to_tm(offset + secs, tm);
 127
 128         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "readtime",
 129                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 130                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 131
 132         return 0;
 133 }
 134
 135 /*
 136  * Set current time and date in RTC
 137  */
 138 static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
 139 {
 140         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 141         int err;
 142         u32 offset, alarm, mr;
 143         unsigned long secs;
 144
 145         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "settime",
 146                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 147                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 148
 149         err = rtc_tm_to_time(tm, &secs);
 150         if (err != 0)
 151                 return err;
 152
 153         mr = rtt_readl(rtc, MR);
 154
 155         /* disable interrupts */
 156         rtt_writel(rtc, MR, mr & ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN));
 157
 158         /* read current time offset */
 159         offset = gpbr_readl(rtc);
 160
 161         /* store the new base time in a battery backup register */
 162         secs += 1;
 163         gpbr_writel(rtc, secs);
 164
 165         /* adjust the alarm time for the new base */
 166         alarm = rtt_readl(rtc, AR);
 167         if (alarm != ALARM_DISABLED) {
 168                 if (offset > secs) {
 169                         /* time jumped backwards, increase time until alarm */
 170                         alarm += (offset - secs);
 171                 } else if ((alarm + offset) > secs) {
 172                         /* time jumped forwards, decrease time until alarm */
 173                         alarm -= (secs - offset);
 174                 } else {
 175                         /* time jumped past the alarm, disable alarm */
 176                         alarm = ALARM_DISABLED;
 177                         mr &= ~AT91_RTT_ALMIEN;
 178                 }
 179                 rtt_writel(rtc, AR, alarm);
 180         }
 181
 182         /* reset the timer, and re-enable interrupts */
 183         rtt_writel(rtc, MR, mr | AT91_RTT_RTTRST);
 184
 185         return 0;
 186 }
 187
 188 static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
 189 {
 190         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 191         struct rtc_time *tm = &alrm->time;
 192         u32 alarm = rtt_readl(rtc, AR);
 193         u32 offset;
 194
 195         offset = gpbr_readl(rtc);
 196         if (offset == 0)
 197                 return -EILSEQ;
 198
 199         memset(alrm, 0, sizeof(*alrm));
 200         if (alarm != ALARM_DISABLED && offset != 0) {
 201                 rtc_time_to_tm(offset + alarm, tm);
 202
 203                 dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "readalarm",
 204                         1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 205                         tm->tm_hour, tm->tm_min, tm->tm_sec);
 206
 207                 if (rtt_readl(rtc, MR) & AT91_RTT_ALMIEN)
 208                         alrm->enabled = 1;
 209         }
 210
 211         return 0;
 212 }
 213
 214 static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
 215 {
 216         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 217         struct rtc_time *tm = &alrm->time;
 218         unsigned long secs;
 219         u32 offset;
 220         u32 mr;
 221         int err;
 222
 223         err = rtc_tm_to_time(tm, &secs);
 224         if (err != 0)
 225                 return err;
 226
 227         offset = gpbr_readl(rtc);
 228         if (offset == 0) {
 229                 /* time is not set */
 230                 return -EILSEQ;
 231         }
 232         mr = rtt_readl(rtc, MR);
 233         rtt_writel(rtc, MR, mr & ~AT91_RTT_ALMIEN);
 234
 235         /* alarm in the past? finish and leave disabled */
 236         if (secs <= offset) {
 237                 rtt_writel(rtc, AR, ALARM_DISABLED);
 238                 return 0;
 239         }
 240
 241         /* else set alarm and maybe enable it */
 242         rtt_writel(rtc, AR, secs - offset);
 243         if (alrm->enabled)
 244                 rtt_writel(rtc, MR, mr | AT91_RTT_ALMIEN);
 245
 246         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "setalarm",
 247                 tm->tm_year, tm->tm_mon, tm->tm_mday, tm->tm_hour,
 248                 tm->tm_min, tm->tm_sec);
 249
 250         return 0;
 251 }
 252
 253 static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 254 {
 255         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 256         u32 mr = rtt_readl(rtc, MR);
 257
 258         dev_dbg(dev, "alarm_irq_enable: enabled=%08x, mr %08x\n", enabled, mr);
 259         if (enabled)
 260                 rtt_writel(rtc, MR, mr | AT91_RTT_ALMIEN);
 261         else
 262                 rtt_writel(rtc, MR, mr & ~AT91_RTT_ALMIEN);
 263         return 0;
 264 }
 265
 266 /*
 267  * Provide additional RTC information in /proc/driver/rtc
 268  */
 269 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
 270 {
 271         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 272         u32 mr = mr = rtt_readl(rtc, MR);
 273
 274         seq_printf(seq, "update_IRQ\t: %s\n",
 275                         (mr & AT91_RTT_RTTINCIEN) ? "yes" : "no");
 276         return 0;
 277 }
 278
 279 static irqreturn_t at91_rtc_cache_events(struct sam9_rtc *rtc)
 280 {
 281         u32 sr, mr;
 282
 283         /* Shared interrupt may be for another device.  Note: reading
 284          * SR clears it, so we must only read it in this irq handler!
 285          */
 286         mr = rtt_readl(rtc, MR) & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 287         sr = rtt_readl(rtc, SR) & (mr >> 16);
 288         if (!sr)
 289                 return IRQ_NONE;
 290
 291         /* alarm status */
 292         if (sr & AT91_RTT_ALMS)
 293                 rtc->events |= (RTC_AF | RTC_IRQF);
 294
 295         /* timer update/increment */
 296         if (sr & AT91_RTT_RTTINC)
 297                 rtc->events |= (RTC_UF | RTC_IRQF);
 298
 299         return IRQ_HANDLED;
 300 }
 301
 302 static void at91_rtc_flush_events(struct sam9_rtc *rtc)
 303 {
 304         if (!rtc->events)
 305                 return;
 306
 307         rtc_update_irq(rtc->rtcdev, 1, rtc->events);
 308         rtc->events = 0;
 309
 310         pr_debug("%s: num=%ld, events=0x%02lx\n", __func__,
 311                 rtc->events >> 8, rtc->events & 0x000000FF);
 312 }
 313
 314 /*
 315  * IRQ handler for the RTC
 316  */
 317 static irqreturn_t at91_rtc_interrupt(int irq, void *_rtc)
 318 {
 319         struct sam9_rtc *rtc = _rtc;
 320         int ret;
 321
 322         spin_lock(&rtc->lock);
 323
 324         ret = at91_rtc_cache_events(rtc);
 325
 326         /* We're called in suspended state */
 327         if (rtc->suspended) {
 328                 /* Mask irqs coming from this peripheral */
 329                 rtt_writel(rtc, MR,
 330                            rtt_readl(rtc, MR) &
 331                            ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN));
 332                 /* Trigger a system wakeup */
 333                 pm_system_wakeup();
 334         } else {
 335                 at91_rtc_flush_events(rtc);
 336         }
 337
 338         spin_unlock(&rtc->lock);
 339
 340         return ret;
 341 }
 342
 343 static const struct rtc_class_ops at91_rtc_ops = {
 344         .read_time      = at91_rtc_readtime,
 345         .set_time       = at91_rtc_settime,
 346         .read_alarm     = at91_rtc_readalarm,
 347         .set_alarm      = at91_rtc_setalarm,
 348         .proc           = at91_rtc_proc,
 349         .alarm_irq_enable = at91_rtc_alarm_irq_enable,
 350 };
 351
 352 static const struct regmap_config gpbr_regmap_config = {
 353         .reg_bits = 32,
 354         .val_bits = 32,
 355         .reg_stride = 4,
 356 };
 357
 358 /*
 359  * Initialize and install RTC driver
 360  */
 361 static int at91_rtc_probe(struct platform_device *pdev)
 362 {
 363         struct resource *r;
 364         struct sam9_rtc *rtc;
 365         int             ret, irq;
 366         u32             mr;
 367         unsigned int    sclk_rate;
 368
 369         irq = platform_get_irq(pdev, 0);
 370         if (irq < 0) {
 371                 dev_err(&pdev->dev, "failed to get interrupt resource\n");
 372                 return irq;
 373         }
 374
 375         rtc = devm_kzalloc(&pdev->dev, sizeof(*rtc), GFP_KERNEL);
 376         if (!rtc)
 377                 return -ENOMEM;
 378
 379         rtc->irq = irq;
 380
 381         /* platform setup code should have handled this; sigh */
 382         if (!device_can_wakeup(&pdev->dev))
 383                 device_init_wakeup(&pdev->dev, 1);
 384
 385         platform_set_drvdata(pdev, rtc);
 386
 387         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 388         rtc->rtt = devm_ioremap_resource(&pdev->dev, r);
 389         if (IS_ERR(rtc->rtt))
 390                 return PTR_ERR(rtc->rtt);
 391
 392         if (!pdev->dev.of_node) {
 393                 /*
 394                  * TODO: Remove this code chunk when removing non DT board
 395                  * support. Remember to remove the gpbr_regmap_config
 396                  * variable too.
 397                  */
 398                 void __iomem *gpbr;
 399
 400                 r = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 401                 gpbr = devm_ioremap_resource(&pdev->dev, r);
 402                 if (IS_ERR(gpbr))
 403                         return PTR_ERR(gpbr);
 404
 405                 rtc->gpbr = regmap_init_mmio(NULL, gpbr,
 406                                              &gpbr_regmap_config);
 407         } else {
 408                 struct of_phandle_args args;
 409
 410                 ret = of_parse_phandle_with_fixed_args(pdev->dev.of_node,
 411                                                 "atmel,rtt-rtc-time-reg", 1, 0,
 412                                                 &args);
 413                 if (ret)
 414                         return ret;
 415
 416                 rtc->gpbr = syscon_node_to_regmap(args.np);
 417                 rtc->gpbr_offset = args.args[0];
 418         }
 419
 420         if (IS_ERR(rtc->gpbr)) {
 421                 dev_err(&pdev->dev, "failed to retrieve gpbr regmap, aborting.\n");
 422                 return -ENOMEM;
 423         }
 424
 425         rtc->sclk = devm_clk_get(&pdev->dev, NULL);
 426         if (IS_ERR(rtc->sclk))
 427                 return PTR_ERR(rtc->sclk);
 428
 429         ret = clk_prepare_enable(rtc->sclk);
 430         if (ret) {
 431                 dev_err(&pdev->dev, "Could not enable slow clock\n");
 432                 return ret;
 433         }
 434
 435         sclk_rate = clk_get_rate(rtc->sclk);
 436         if (!sclk_rate || sclk_rate > AT91_RTT_RTPRES) {
 437                 dev_err(&pdev->dev, "Invalid slow clock rate\n");
 438                 ret = -EINVAL;
 439                 goto err_clk;
 440         }
 441
 442         mr = rtt_readl(rtc, MR);
 443
 444         /* unless RTT is counting at 1 Hz, re-initialize it */
 445         if ((mr & AT91_RTT_RTPRES) != sclk_rate) {
 446                 mr = AT91_RTT_RTTRST | (sclk_rate & AT91_RTT_RTPRES);
 447                 gpbr_writel(rtc, 0);
 448         }
 449
 450         /* disable all interrupts (same as on shutdown path) */
 451         mr &= ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 452         rtt_writel(rtc, MR, mr);
 453
 454         rtc->rtcdev = devm_rtc_device_register(&pdev->dev, pdev->name,
 455                                         &at91_rtc_ops, THIS_MODULE);
 456         if (IS_ERR(rtc->rtcdev)) {
 457                 ret = PTR_ERR(rtc->rtcdev);
 458                 goto err_clk;
 459         }
 460
 461         /* register irq handler after we know what name we'll use */
 462         ret = devm_request_irq(&pdev->dev, rtc->irq, at91_rtc_interrupt,
 463                                IRQF_SHARED | IRQF_COND_SUSPEND,
 464                                dev_name(&rtc->rtcdev->dev), rtc);
 465         if (ret) {
 466                 dev_dbg(&pdev->dev, "can't share IRQ %d?\n", rtc->irq);
 467                 goto err_clk;
 468         }
 469
 470         /* NOTE:  sam9260 rev A silicon has a ROM bug which resets the
 471          * RTT on at least some reboots.  If you have that chip, you must
 472          * initialize the time from some external source like a GPS, wall
 473          * clock, discrete RTC, etc
 474          */
 475
 476         if (gpbr_readl(rtc) == 0)
 477                 dev_warn(&pdev->dev, "%s: SET TIME!\n",
 478                                 dev_name(&rtc->rtcdev->dev));
 479
 480         return 0;
 481
 482 err_clk:
 483         clk_disable_unprepare(rtc->sclk);
 484
 485         return ret;
 486 }
 487
 488 /*
 489  * Disable and remove the RTC driver
 490  */
 491 static int at91_rtc_remove(struct platform_device *pdev)
 492 {
 493         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 494         u32             mr = rtt_readl(rtc, MR);
 495
 496         /* disable all interrupts */
 497         rtt_writel(rtc, MR, mr & ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN));
 498
 499         clk_disable_unprepare(rtc->sclk);
 500
 501         return 0;
 502 }
 503
 504 static void at91_rtc_shutdown(struct platform_device *pdev)
 505 {
 506         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 507         u32             mr = rtt_readl(rtc, MR);
 508
 509         rtc->imr = mr & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 510         rtt_writel(rtc, MR, mr & ~rtc->imr);
 511 }
 512
 513 #ifdef CONFIG_PM_SLEEP
 514
 515 /* AT91SAM9 RTC Power management control */
 516
 517 static int at91_rtc_suspend(struct device *dev)
 518 {
 519         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 520         u32             mr = rtt_readl(rtc, MR);
 521
 522         /*
 523          * This IRQ is shared with DBGU and other hardware which isn't
 524          * necessarily a wakeup event source.
 525          */
 526         rtc->imr = mr & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 527         if (rtc->imr) {
 528                 if (device_may_wakeup(dev) && (mr & AT91_RTT_ALMIEN)) {
 529                         unsigned long flags;
 530
 531                         enable_irq_wake(rtc->irq);
 532                         spin_lock_irqsave(&rtc->lock, flags);
 533                         rtc->suspended = true;
 534                         spin_unlock_irqrestore(&rtc->lock, flags);
 535                         /* don't let RTTINC cause wakeups */
 536                         if (mr & AT91_RTT_RTTINCIEN)
 537                                 rtt_writel(rtc, MR, mr & ~AT91_RTT_RTTINCIEN);
 538                 } else
 539                         rtt_writel(rtc, MR, mr & ~rtc->imr);
 540         }
 541
 542         return 0;
 543 }
 544
 545 static int at91_rtc_resume(struct device *dev)
 546 {
 547         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 548         u32             mr;
 549
 550         if (rtc->imr) {
 551                 unsigned long flags;
 552
 553                 if (device_may_wakeup(dev))
 554                         disable_irq_wake(rtc->irq);
 555                 mr = rtt_readl(rtc, MR);
 556                 rtt_writel(rtc, MR, mr | rtc->imr);
 557
 558                 spin_lock_irqsave(&rtc->lock, flags);
 559                 rtc->suspended = false;
 560                 at91_rtc_cache_events(rtc);
 561                 at91_rtc_flush_events(rtc);
 562                 spin_unlock_irqrestore(&rtc->lock, flags);
 563         }
 564
 565         return 0;
 566 }
 567 #endif
 568
 569 static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
 570
 571 #ifdef CONFIG_OF
 572 static const struct of_device_id at91_rtc_dt_ids[] = {
 573         { .compatible = "atmel,at91sam9260-rtt" },
 574         { /* sentinel */ }
 575 };
 576 MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
 577 #endif
 578
 579 static struct platform_driver at91_rtc_driver = {
 580         .probe          = at91_rtc_probe,
 581         .remove         = at91_rtc_remove,
 582         .shutdown       = at91_rtc_shutdown,
 583         .driver         = {
 584                 .name   = "rtc-at91sam9",
 585                 .pm     = &at91_rtc_pm_ops,
 586                 .of_match_table = of_match_ptr(at91_rtc_dt_ids),
 587         },
 588 };
 589
 590 module_platform_driver(at91_rtc_driver);
 591
 592 MODULE_AUTHOR("Michel Benoit");
 593 MODULE_DESCRIPTION("RTC driver for Atmel AT91SAM9x");
 594 MODULE_LICENSE("GPL");