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/module.h>
  15 #include <linux/kernel.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/time.h>
  18 #include <linux/rtc.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/ioctl.h>
  21 #include <linux/slab.h>
  22
  23 #include <mach/board.h>
  24 #include <mach/at91_rtt.h>
  25 #include <mach/cpu.h>
  26
  27
  28 /*
  29  * This driver uses two configurable hardware resources that live in the
  30  * AT91SAM9 backup power domain (intended to be powered at all times)
  31  * to implement the Real Time Clock interfaces
  32  *
  33  *  - A "Real-time Timer" (RTT) counts up in seconds from a base time.
  34  *    We can't assign the counter value (CRTV) ... but we can reset it.
  35  *
  36  *  - One of the "General Purpose Backup Registers" (GPBRs) holds the
  37  *    base time, normally an offset from the beginning of the POSIX
  38  *    epoch (1970-Jan-1 00:00:00 UTC).  Some systems also include the
  39  *    local timezone's offset.
  40  *
  41  * The RTC's value is the RTT counter plus that offset.  The RTC's alarm
  42  * is likewise a base (ALMV) plus that offset.
  43  *
  44  * Not all RTTs will be used as RTCs; some systems have multiple RTTs to
  45  * choose from, or a "real" RTC module.  All systems have multiple GPBR
  46  * registers available, likewise usable for more than "RTC" support.
  47  */
  48
  49 /*
  50  * We store ALARM_DISABLED in ALMV to record that no alarm is set.
  51  * It's also the reset value for that field.
  52  */
  53 #define ALARM_DISABLED  ((u32)~0)
  54
  55
  56 struct sam9_rtc {
  57         void __iomem            *rtt;
  58         struct rtc_device       *rtcdev;
  59         u32                     imr;
  60 };
  61
  62 #define rtt_readl(rtc, field) \
  63         __raw_readl((rtc)->rtt + AT91_RTT_ ## field)
  64 #define rtt_writel(rtc, field, val) \
  65         __raw_writel((val), (rtc)->rtt + AT91_RTT_ ## field)
  66
  67 #define gpbr_readl(rtc) \
  68         at91_sys_read(AT91_GPBR + 4 * CONFIG_RTC_DRV_AT91SAM9_GPBR)
  69 #define gpbr_writel(rtc, val) \
  70         at91_sys_write(AT91_GPBR + 4 * CONFIG_RTC_DRV_AT91SAM9_GPBR, (val))
  71
  72 /*
  73  * Read current time and date in RTC
  74  */
  75 static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
  76 {
  77         struct sam9_rtc *rtc = dev_get_drvdata(dev);
  78         u32 secs, secs2;
  79         u32 offset;
  80
  81         /* read current time offset */
  82         offset = gpbr_readl(rtc);
  83         if (offset == 0)
  84                 return -EILSEQ;
  85
  86         /* reread the counter to help sync the two clock domains */
  87         secs = rtt_readl(rtc, VR);
  88         secs2 = rtt_readl(rtc, VR);
  89         if (secs != secs2)
  90                 secs = rtt_readl(rtc, VR);
  91
  92         rtc_time_to_tm(offset + secs, tm);
  93
  94         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "readtime",
  95                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
  96                 tm->tm_hour, tm->tm_min, tm->tm_sec);
  97
  98         return 0;
  99 }
 100
 101 /*
 102  * Set current time and date in RTC
 103  */
 104 static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
 105 {
 106         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 107         int err;
 108         u32 offset, alarm, mr;
 109         unsigned long secs;
 110
 111         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "settime",
 112                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 113                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 114
 115         err = rtc_tm_to_time(tm, &secs);
 116         if (err != 0)
 117                 return err;
 118
 119         mr = rtt_readl(rtc, MR);
 120
 121         /* disable interrupts */
 122         rtt_writel(rtc, MR, mr & ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN));
 123
 124         /* read current time offset */
 125         offset = gpbr_readl(rtc);
 126
 127         /* store the new base time in a battery backup register */
 128         secs += 1;
 129         gpbr_writel(rtc, secs);
 130
 131         /* adjust the alarm time for the new base */
 132         alarm = rtt_readl(rtc, AR);
 133         if (alarm != ALARM_DISABLED) {
 134                 if (offset > secs) {
 135                         /* time jumped backwards, increase time until alarm */
 136                         alarm += (offset - secs);
 137                 } else if ((alarm + offset) > secs) {
 138                         /* time jumped forwards, decrease time until alarm */
 139                         alarm -= (secs - offset);
 140                 } else {
 141                         /* time jumped past the alarm, disable alarm */
 142                         alarm = ALARM_DISABLED;
 143                         mr &= ~AT91_RTT_ALMIEN;
 144                 }
 145                 rtt_writel(rtc, AR, alarm);
 146         }
 147
 148         /* reset the timer, and re-enable interrupts */
 149         rtt_writel(rtc, MR, mr | AT91_RTT_RTTRST);
 150
 151         return 0;
 152 }
 153
 154 static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
 155 {
 156         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 157         struct rtc_time *tm = &alrm->time;
 158         u32 alarm = rtt_readl(rtc, AR);
 159         u32 offset;
 160
 161         offset = gpbr_readl(rtc);
 162         if (offset == 0)
 163                 return -EILSEQ;
 164
 165         memset(alrm, 0, sizeof(*alrm));
 166         if (alarm != ALARM_DISABLED && offset != 0) {
 167                 rtc_time_to_tm(offset + alarm, tm);
 168
 169                 dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "readalarm",
 170                         1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 171                         tm->tm_hour, tm->tm_min, tm->tm_sec);
 172
 173                 if (rtt_readl(rtc, MR) & AT91_RTT_ALMIEN)
 174                         alrm->enabled = 1;
 175         }
 176
 177         return 0;
 178 }
 179
 180 static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
 181 {
 182         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 183         struct rtc_time *tm = &alrm->time;
 184         unsigned long secs;
 185         u32 offset;
 186         u32 mr;
 187         int err;
 188
 189         err = rtc_tm_to_time(tm, &secs);
 190         if (err != 0)
 191                 return err;
 192
 193         offset = gpbr_readl(rtc);
 194         if (offset == 0) {
 195                 /* time is not set */
 196                 return -EILSEQ;
 197         }
 198         mr = rtt_readl(rtc, MR);
 199         rtt_writel(rtc, MR, mr & ~AT91_RTT_ALMIEN);
 200
 201         /* alarm in the past? finish and leave disabled */
 202         if (secs <= offset) {
 203                 rtt_writel(rtc, AR, ALARM_DISABLED);
 204                 return 0;
 205         }
 206
 207         /* else set alarm and maybe enable it */
 208         rtt_writel(rtc, AR, secs - offset);
 209         if (alrm->enabled)
 210                 rtt_writel(rtc, MR, mr | AT91_RTT_ALMIEN);
 211
 212         dev_dbg(dev, "%s: %4d-%02d-%02d %02d:%02d:%02d\n", "setalarm",
 213                 tm->tm_year, tm->tm_mon, tm->tm_mday, tm->tm_hour,
 214                 tm->tm_min, tm->tm_sec);
 215
 216         return 0;
 217 }
 218
 219 /*
 220  * Handle commands from user-space
 221  */
 222 static int at91_rtc_ioctl(struct device *dev, unsigned int cmd,
 223                         unsigned long arg)
 224 {
 225         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 226         int ret = 0;
 227         u32 mr = rtt_readl(rtc, MR);
 228
 229         dev_dbg(dev, "ioctl: cmd=%08x, arg=%08lx, mr %08x\n", cmd, arg, mr);
 230
 231         switch (cmd) {
 232         case RTC_UIE_OFF:               /* update off */
 233                 rtt_writel(rtc, MR, mr & ~AT91_RTT_RTTINCIEN);
 234                 break;
 235         case RTC_UIE_ON:                /* update on */
 236                 rtt_writel(rtc, MR, mr | AT91_RTT_RTTINCIEN);
 237                 break;
 238         default:
 239                 ret = -ENOIOCTLCMD;
 240                 break;
 241         }
 242
 243         return ret;
 244 }
 245
 246 static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 247 {
 248         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 249         u32 mr = rtt_readl(rtc, MR);
 250
 251         dev_dbg(dev, "alarm_irq_enable: enabled=%08x, mr %08x\n", enabled, mr);
 252         if (enabled)
 253                 rtt_writel(rtc, MR, mr | AT91_RTT_ALMIEN);
 254         else
 255                 rtt_writel(rtc, MR, mr & ~AT91_RTT_ALMIEN);
 256         return 0;
 257 }
 258
 259 /*
 260  * Provide additional RTC information in /proc/driver/rtc
 261  */
 262 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
 263 {
 264         struct sam9_rtc *rtc = dev_get_drvdata(dev);
 265         u32 mr = mr = rtt_readl(rtc, MR);
 266
 267         seq_printf(seq, "update_IRQ\t: %s\n",
 268                         (mr & AT91_RTT_RTTINCIEN) ? "yes" : "no");
 269         return 0;
 270 }
 271
 272 /*
 273  * IRQ handler for the RTC
 274  */
 275 static irqreturn_t at91_rtc_interrupt(int irq, void *_rtc)
 276 {
 277         struct sam9_rtc *rtc = _rtc;
 278         u32 sr, mr;
 279         unsigned long events = 0;
 280
 281         /* Shared interrupt may be for another device.  Note: reading
 282          * SR clears it, so we must only read it in this irq handler!
 283          */
 284         mr = rtt_readl(rtc, MR) & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 285         sr = rtt_readl(rtc, SR) & (mr >> 16);
 286         if (!sr)
 287                 return IRQ_NONE;
 288
 289         /* alarm status */
 290         if (sr & AT91_RTT_ALMS)
 291                 events |= (RTC_AF | RTC_IRQF);
 292
 293         /* timer update/increment */
 294         if (sr & AT91_RTT_RTTINC)
 295                 events |= (RTC_UF | RTC_IRQF);
 296
 297         rtc_update_irq(rtc->rtcdev, 1, events);
 298
 299         pr_debug("%s: num=%ld, events=0x%02lx\n", __func__,
 300                 events >> 8, events & 0x000000FF);
 301
 302         return IRQ_HANDLED;
 303 }
 304
 305 static const struct rtc_class_ops at91_rtc_ops = {
 306         .ioctl          = at91_rtc_ioctl,
 307         .read_time      = at91_rtc_readtime,
 308         .set_time       = at91_rtc_settime,
 309         .read_alarm     = at91_rtc_readalarm,
 310         .set_alarm      = at91_rtc_setalarm,
 311         .proc           = at91_rtc_proc,
 312         .alarm_irq_enable = at91_rtc_alarm_irq_enable,
 313 };
 314
 315 /*
 316  * Initialize and install RTC driver
 317  */
 318 static int __init at91_rtc_probe(struct platform_device *pdev)
 319 {
 320         struct resource *r;
 321         struct sam9_rtc *rtc;
 322         int             ret;
 323         u32             mr;
 324
 325         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 326         if (!r)
 327                 return -ENODEV;
 328
 329         rtc = kzalloc(sizeof *rtc, GFP_KERNEL);
 330         if (!rtc)
 331                 return -ENOMEM;
 332
 333         /* platform setup code should have handled this; sigh */
 334         if (!device_can_wakeup(&pdev->dev))
 335                 device_init_wakeup(&pdev->dev, 1);
 336
 337         platform_set_drvdata(pdev, rtc);
 338         rtc->rtt = (void __force __iomem *) (AT91_VA_BASE_SYS - AT91_BASE_SYS);
 339         rtc->rtt += r->start;
 340
 341         mr = rtt_readl(rtc, MR);
 342
 343         /* unless RTT is counting at 1 Hz, re-initialize it */
 344         if ((mr & AT91_RTT_RTPRES) != AT91_SLOW_CLOCK) {
 345                 mr = AT91_RTT_RTTRST | (AT91_SLOW_CLOCK & AT91_RTT_RTPRES);
 346                 gpbr_writel(rtc, 0);
 347         }
 348
 349         /* disable all interrupts (same as on shutdown path) */
 350         mr &= ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 351         rtt_writel(rtc, MR, mr);
 352
 353         rtc->rtcdev = rtc_device_register(pdev->name, &pdev->dev,
 354                                 &at91_rtc_ops, THIS_MODULE);
 355         if (IS_ERR(rtc->rtcdev)) {
 356                 ret = PTR_ERR(rtc->rtcdev);
 357                 goto fail;
 358         }
 359
 360         /* register irq handler after we know what name we'll use */
 361         ret = request_irq(AT91_ID_SYS, at91_rtc_interrupt,
 362                                 IRQF_DISABLED | IRQF_SHARED,
 363                                 dev_name(&rtc->rtcdev->dev), rtc);
 364         if (ret) {
 365                 dev_dbg(&pdev->dev, "can't share IRQ %d?\n", AT91_ID_SYS);
 366                 rtc_device_unregister(rtc->rtcdev);
 367                 goto fail;
 368         }
 369
 370         /* NOTE:  sam9260 rev A silicon has a ROM bug which resets the
 371          * RTT on at least some reboots.  If you have that chip, you must
 372          * initialize the time from some external source like a GPS, wall
 373          * clock, discrete RTC, etc
 374          */
 375
 376         if (gpbr_readl(rtc) == 0)
 377                 dev_warn(&pdev->dev, "%s: SET TIME!\n",
 378                                 dev_name(&rtc->rtcdev->dev));
 379
 380         return 0;
 381
 382 fail:
 383         platform_set_drvdata(pdev, NULL);
 384         kfree(rtc);
 385         return ret;
 386 }
 387
 388 /*
 389  * Disable and remove the RTC driver
 390  */
 391 static int __exit at91_rtc_remove(struct platform_device *pdev)
 392 {
 393         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 394         u32             mr = rtt_readl(rtc, MR);
 395
 396         /* disable all interrupts */
 397         rtt_writel(rtc, MR, mr & ~(AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN));
 398         free_irq(AT91_ID_SYS, rtc);
 399
 400         rtc_device_unregister(rtc->rtcdev);
 401
 402         platform_set_drvdata(pdev, NULL);
 403         kfree(rtc);
 404         return 0;
 405 }
 406
 407 static void at91_rtc_shutdown(struct platform_device *pdev)
 408 {
 409         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 410         u32             mr = rtt_readl(rtc, MR);
 411
 412         rtc->imr = mr & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 413         rtt_writel(rtc, MR, mr & ~rtc->imr);
 414 }
 415
 416 #ifdef CONFIG_PM
 417
 418 /* AT91SAM9 RTC Power management control */
 419
 420 static int at91_rtc_suspend(struct platform_device *pdev,
 421                                         pm_message_t state)
 422 {
 423         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 424         u32             mr = rtt_readl(rtc, MR);
 425
 426         /*
 427          * This IRQ is shared with DBGU and other hardware which isn't
 428          * necessarily a wakeup event source.
 429          */
 430         rtc->imr = mr & (AT91_RTT_ALMIEN | AT91_RTT_RTTINCIEN);
 431         if (rtc->imr) {
 432                 if (device_may_wakeup(&pdev->dev) && (mr & AT91_RTT_ALMIEN)) {
 433                         enable_irq_wake(AT91_ID_SYS);
 434                         /* don't let RTTINC cause wakeups */
 435                         if (mr & AT91_RTT_RTTINCIEN)
 436                                 rtt_writel(rtc, MR, mr & ~AT91_RTT_RTTINCIEN);
 437                 } else
 438                         rtt_writel(rtc, MR, mr & ~rtc->imr);
 439         }
 440
 441         return 0;
 442 }
 443
 444 static int at91_rtc_resume(struct platform_device *pdev)
 445 {
 446         struct sam9_rtc *rtc = platform_get_drvdata(pdev);
 447         u32             mr;
 448
 449         if (rtc->imr) {
 450                 if (device_may_wakeup(&pdev->dev))
 451                         disable_irq_wake(AT91_ID_SYS);
 452                 mr = rtt_readl(rtc, MR);
 453                 rtt_writel(rtc, MR, mr | rtc->imr);
 454         }
 455
 456         return 0;
 457 }
 458 #else
 459 #define at91_rtc_suspend        NULL
 460 #define at91_rtc_resume         NULL
 461 #endif
 462
 463 static struct platform_driver at91_rtc_driver = {
 464         .driver.name    = "rtc-at91sam9",
 465         .driver.owner   = THIS_MODULE,
 466         .remove         = __exit_p(at91_rtc_remove),
 467         .shutdown       = at91_rtc_shutdown,
 468         .suspend        = at91_rtc_suspend,
 469         .resume         = at91_rtc_resume,
 470 };
 471
 472 /* Chips can have more than one RTT module, and they can be used for more
 473  * than just RTCs.  So we can't just register as "the" RTT driver.
 474  *
 475  * A normal approach in such cases is to create a library to allocate and
 476  * free the modules.  Here we just use bus_find_device() as like such a
 477  * library, binding directly ... no runtime "library" footprint is needed.
 478  */
 479 static int __init at91_rtc_match(struct device *dev, void *v)
 480 {
 481         struct platform_device *pdev = to_platform_device(dev);
 482         int ret;
 483
 484         /* continue searching if this isn't the RTT we need */
 485         if (strcmp("at91_rtt", pdev->name) != 0
 486                         || pdev->id != CONFIG_RTC_DRV_AT91SAM9_RTT)
 487                 goto fail;
 488
 489         /* else we found it ... but fail unless we can bind to the RTC driver */
 490         if (dev->driver) {
 491                 dev_dbg(dev, "busy, can't use as RTC!\n");
 492                 goto fail;
 493         }
 494         dev->driver = &at91_rtc_driver.driver;
 495         if (device_attach(dev) == 0) {
 496                 dev_dbg(dev, "can't attach RTC!\n");
 497                 goto fail;
 498         }
 499         ret = at91_rtc_probe(pdev);
 500         if (ret == 0)
 501                 return true;
 502
 503         dev_dbg(dev, "RTC probe err %d!\n", ret);
 504 fail:
 505         return false;
 506 }
 507
 508 static int __init at91_rtc_init(void)
 509 {
 510         int status;
 511         struct device *rtc;
 512
 513         status = platform_driver_register(&at91_rtc_driver);
 514         if (status)
 515                 return status;
 516         rtc = bus_find_device(&platform_bus_type, NULL,
 517                         NULL, at91_rtc_match);
 518         if (!rtc)
 519                 platform_driver_unregister(&at91_rtc_driver);
 520         return rtc ? 0 : -ENODEV;
 521 }
 522 module_init(at91_rtc_init);
 523
 524 static void __exit at91_rtc_exit(void)
 525 {
 526         platform_driver_unregister(&at91_rtc_driver);
 527 }
 528 module_exit(at91_rtc_exit);
 529
 530
 531 MODULE_AUTHOR("Michel Benoit");
 532 MODULE_DESCRIPTION("RTC driver for Atmel AT91SAM9x");
 533 MODULE_LICENSE("GPL");