drivers/rtc/rtc-sa1100.c

   1 /*
   2  * Real Time Clock interface for StrongARM SA1x00 and XScale PXA2xx
   3  *
   4  * Copyright (c) 2000 Nils Faerber
   5  *
   6  * Based on rtc.c by Paul Gortmaker
   7  *
   8  * Original Driver by Nils Faerber <nils@kernelconcepts.de>
   9  *
  10  * Modifications from:
  11  *   CIH <cih@coventive.com>
  12  *   Nicolas Pitre <nico@fluxnic.net>
  13  *   Andrew Christian <andrew.christian@hp.com>
  14  *
  15  * Converted to the RTC subsystem and Driver Model
  16  *   by Richard Purdie <rpurdie@rpsys.net>
  17  *
  18  * This program is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU General Public License
  20  * as published by the Free Software Foundation; either version
  21  * 2 of the License, or (at your option) any later version.
  22  */
  23
  24 #include <linux/platform_device.h>
  25 #include <linux/module.h>
  26 #include <linux/rtc.h>
  27 #include <linux/init.h>
  28 #include <linux/fs.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/string.h>
  31 #include <linux/pm.h>
  32 #include <linux/bitops.h>
  33
  34 #include <mach/hardware.h>
  35 #include <asm/irq.h>
  36
  37 #ifdef CONFIG_ARCH_PXA
  38 #include <mach/regs-rtc.h>
  39 #include <mach/regs-ost.h>
  40 #endif
  41
  42 #define RTC_DEF_DIVIDER         (32768 - 1)
  43 #define RTC_DEF_TRIM            0
  44
  45 static const unsigned long RTC_FREQ = 1024;
  46 static unsigned long timer_freq;
  47 static struct rtc_time rtc_alarm;
  48 static DEFINE_SPINLOCK(sa1100_rtc_lock);
  49
  50 static inline int rtc_periodic_alarm(struct rtc_time *tm)
  51 {
  52         return  (tm->tm_year == -1) ||
  53                 ((unsigned)tm->tm_mon >= 12) ||
  54                 ((unsigned)(tm->tm_mday - 1) >= 31) ||
  55                 ((unsigned)tm->tm_hour > 23) ||
  56                 ((unsigned)tm->tm_min > 59) ||
  57                 ((unsigned)tm->tm_sec > 59);
  58 }
  59
  60 /*
  61  * Calculate the next alarm time given the requested alarm time mask
  62  * and the current time.
  63  */
  64 static void rtc_next_alarm_time(struct rtc_time *next, struct rtc_time *now,
  65         struct rtc_time *alrm)
  66 {
  67         unsigned long next_time;
  68         unsigned long now_time;
  69
  70         next->tm_year = now->tm_year;
  71         next->tm_mon = now->tm_mon;
  72         next->tm_mday = now->tm_mday;
  73         next->tm_hour = alrm->tm_hour;
  74         next->tm_min = alrm->tm_min;
  75         next->tm_sec = alrm->tm_sec;
  76
  77         rtc_tm_to_time(now, &now_time);
  78         rtc_tm_to_time(next, &next_time);
  79
  80         if (next_time < now_time) {
  81                 /* Advance one day */
  82                 next_time += 60 * 60 * 24;
  83                 rtc_time_to_tm(next_time, next);
  84         }
  85 }
  86
  87 static int rtc_update_alarm(struct rtc_time *alrm)
  88 {
  89         struct rtc_time alarm_tm, now_tm;
  90         unsigned long now, time;
  91         int ret;
  92
  93         do {
  94                 now = RCNR;
  95                 rtc_time_to_tm(now, &now_tm);
  96                 rtc_next_alarm_time(&alarm_tm, &now_tm, alrm);
  97                 ret = rtc_tm_to_time(&alarm_tm, &time);
  98                 if (ret != 0)
  99                         break;
 100
 101                 RTSR = RTSR & (RTSR_HZE|RTSR_ALE|RTSR_AL);
 102                 RTAR = time;
 103         } while (now != RCNR);
 104
 105         return ret;
 106 }
 107
 108 static irqreturn_t sa1100_rtc_interrupt(int irq, void *dev_id)
 109 {
 110         struct platform_device *pdev = to_platform_device(dev_id);
 111         struct rtc_device *rtc = platform_get_drvdata(pdev);
 112         unsigned int rtsr;
 113         unsigned long events = 0;
 114
 115         spin_lock(&sa1100_rtc_lock);
 116
 117         rtsr = RTSR;
 118         /* clear interrupt sources */
 119         RTSR = 0;
 120         /* Fix for a nasty initialization problem the in SA11xx RTSR register.
 121          * See also the comments in sa1100_rtc_probe(). */
 122         if (rtsr & (RTSR_ALE | RTSR_HZE)) {
 123                 /* This is the original code, before there was the if test
 124                  * above. This code does not clear interrupts that were not
 125                  * enabled. */
 126                 RTSR = (RTSR_AL | RTSR_HZ) & (rtsr >> 2);
 127         } else {
 128                 /* For some reason, it is possible to enter this routine
 129                  * without interruptions enabled, it has been tested with
 130                  * several units (Bug in SA11xx chip?).
 131                  *
 132                  * This situation leads to an infinite "loop" of interrupt
 133                  * routine calling and as a result the processor seems to
 134                  * lock on its first call to open(). */
 135                 RTSR = RTSR_AL | RTSR_HZ;
 136         }
 137
 138         /* clear alarm interrupt if it has occurred */
 139         if (rtsr & RTSR_AL)
 140                 rtsr &= ~RTSR_ALE;
 141         RTSR = rtsr & (RTSR_ALE | RTSR_HZE);
 142
 143         /* update irq data & counter */
 144         if (rtsr & RTSR_AL)
 145                 events |= RTC_AF | RTC_IRQF;
 146         if (rtsr & RTSR_HZ)
 147                 events |= RTC_UF | RTC_IRQF;
 148
 149         rtc_update_irq(rtc, 1, events);
 150
 151         if (rtsr & RTSR_AL && rtc_periodic_alarm(&rtc_alarm))
 152                 rtc_update_alarm(&rtc_alarm);
 153
 154         spin_unlock(&sa1100_rtc_lock);
 155
 156         return IRQ_HANDLED;
 157 }
 158
 159 static int sa1100_irq_set_freq(struct device *dev, int freq)
 160 {
 161         if (freq < 1 || freq > timer_freq) {
 162                 return -EINVAL;
 163         } else {
 164                 struct rtc_device *rtc = (struct rtc_device *)dev;
 165
 166                 rtc->irq_freq = freq;
 167
 168                 return 0;
 169         }
 170 }
 171
 172 static int rtc_timer1_count;
 173
 174 static inline int sa1100_timer1_retrigger(struct rtc_device *rtc)
 175 {
 176         unsigned long diff;
 177         unsigned long period = timer_freq / rtc->irq_freq;
 178
 179         spin_lock_irq(&sa1100_rtc_lock);
 180
 181         do {
 182                 OSMR1 += period;
 183                 diff = OSMR1 - OSCR;
 184                 /* If OSCR > OSMR1, diff is a very large number (unsigned
 185                  * math). This means we have a lost interrupt. */
 186         } while (diff > period);
 187         OIER |= OIER_E1;
 188
 189         spin_unlock_irq(&sa1100_rtc_lock);
 190
 191         return 0;
 192 }
 193
 194 static irqreturn_t timer1_interrupt(int irq, void *dev_id)
 195 {
 196         struct platform_device *pdev = to_platform_device(dev_id);
 197         struct rtc_device *rtc = platform_get_drvdata(pdev);
 198
 199         /*
 200          * If we match for the first time, rtc_timer1_count will be 1.
 201          * Otherwise, we wrapped around (very unlikely but
 202          * still possible) so compute the amount of missed periods.
 203          * The match reg is updated only when the data is actually retrieved
 204          * to avoid unnecessary interrupts.
 205          */
 206         OSSR = OSSR_M1; /* clear match on timer1 */
 207
 208         rtc_update_irq(rtc, rtc_timer1_count, RTC_PF | RTC_IRQF);
 209
 210         if (rtc_timer1_count == 1)
 211                 rtc_timer1_count =
 212                         (rtc->irq_freq * ((1 << 30) / (timer_freq >> 2)));
 213
 214         /* retrigger. */
 215         sa1100_timer1_retrigger(rtc);
 216
 217         return IRQ_HANDLED;
 218 }
 219
 220 static int sa1100_rtc_read_callback(struct device *dev, int data)
 221 {
 222         if (data & RTC_PF) {
 223                 struct rtc_device *rtc = (struct rtc_device *)dev;
 224
 225                 /* interpolate missed periods and set match for the next */
 226                 unsigned long period = timer_freq / rtc->irq_freq;
 227                 unsigned long oscr = OSCR;
 228                 unsigned long osmr1 = OSMR1;
 229                 unsigned long missed = (oscr - osmr1)/period;
 230                 data += missed << 8;
 231                 OSSR = OSSR_M1; /* clear match on timer 1 */
 232                 OSMR1 = osmr1 + (missed + 1)*period;
 233                 /* Ensure we didn't miss another match in the mean time.
 234                  * Here we compare (match - OSCR) 8 instead of 0 --
 235                  * see comment in pxa_timer_interrupt() for explanation.
 236                  */
 237                 while ((signed long)((osmr1 = OSMR1) - OSCR) <= 8) {
 238                         data += 0x100;
 239                         OSSR = OSSR_M1; /* clear match on timer 1 */
 240                         OSMR1 = osmr1 + period;
 241                 }
 242         }
 243         return data;
 244 }
 245
 246 static int sa1100_rtc_open(struct device *dev)
 247 {
 248         int ret;
 249         struct rtc_device *rtc = (struct rtc_device *)dev;
 250
 251         ret = request_irq(IRQ_RTC1Hz, sa1100_rtc_interrupt, IRQF_DISABLED,
 252                 "rtc 1Hz", dev);
 253         if (ret) {
 254                 dev_err(dev, "IRQ %d already in use.\n", IRQ_RTC1Hz);
 255                 goto fail_ui;
 256         }
 257         ret = request_irq(IRQ_RTCAlrm, sa1100_rtc_interrupt, IRQF_DISABLED,
 258                 "rtc Alrm", dev);
 259         if (ret) {
 260                 dev_err(dev, "IRQ %d already in use.\n", IRQ_RTCAlrm);
 261                 goto fail_ai;
 262         }
 263         ret = request_irq(IRQ_OST1, timer1_interrupt, IRQF_DISABLED,
 264                 "rtc timer", dev);
 265         if (ret) {
 266                 dev_err(dev, "IRQ %d already in use.\n", IRQ_OST1);
 267                 goto fail_pi;
 268         }
 269         rtc->max_user_freq = RTC_FREQ;
 270         sa1100_irq_set_freq(dev, RTC_FREQ);
 271
 272         return 0;
 273
 274  fail_pi:
 275         free_irq(IRQ_RTCAlrm, dev);
 276  fail_ai:
 277         free_irq(IRQ_RTC1Hz, dev);
 278  fail_ui:
 279         return ret;
 280 }
 281
 282 static void sa1100_rtc_release(struct device *dev)
 283 {
 284         spin_lock_irq(&sa1100_rtc_lock);
 285         RTSR = 0;
 286         OIER &= ~OIER_E1;
 287         OSSR = OSSR_M1;
 288         spin_unlock_irq(&sa1100_rtc_lock);
 289
 290         free_irq(IRQ_OST1, dev);
 291         free_irq(IRQ_RTCAlrm, dev);
 292         free_irq(IRQ_RTC1Hz, dev);
 293 }
 294
 295
 296 static int sa1100_rtc_ioctl(struct device *dev, unsigned int cmd,
 297                 unsigned long arg)
 298 {
 299         switch (cmd) {
 300         case RTC_UIE_OFF:
 301                 spin_lock_irq(&sa1100_rtc_lock);
 302                 RTSR &= ~RTSR_HZE;
 303                 spin_unlock_irq(&sa1100_rtc_lock);
 304                 return 0;
 305         case RTC_UIE_ON:
 306                 spin_lock_irq(&sa1100_rtc_lock);
 307                 RTSR |= RTSR_HZE;
 308                 spin_unlock_irq(&sa1100_rtc_lock);
 309                 return 0;
 310         }
 311         return -ENOIOCTLCMD;
 312 }
 313
 314 static int sa1100_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 315 {
 316         spin_lock_irq(&sa1100_rtc_lock);
 317         if (enabled)
 318                 RTSR |= RTSR_ALE;
 319         else
 320                 RTSR &= ~RTSR_ALE;
 321         spin_unlock_irq(&sa1100_rtc_lock);
 322         return 0;
 323 }
 324
 325 static int sa1100_rtc_read_time(struct device *dev, struct rtc_time *tm)
 326 {
 327         rtc_time_to_tm(RCNR, tm);
 328         return 0;
 329 }
 330
 331 static int sa1100_rtc_set_time(struct device *dev, struct rtc_time *tm)
 332 {
 333         unsigned long time;
 334         int ret;
 335
 336         ret = rtc_tm_to_time(tm, &time);
 337         if (ret == 0)
 338                 RCNR = time;
 339         return ret;
 340 }
 341
 342 static int sa1100_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 343 {
 344         u32     rtsr;
 345
 346         memcpy(&alrm->time, &rtc_alarm, sizeof(struct rtc_time));
 347         rtsr = RTSR;
 348         alrm->enabled = (rtsr & RTSR_ALE) ? 1 : 0;
 349         alrm->pending = (rtsr & RTSR_AL) ? 1 : 0;
 350         return 0;
 351 }
 352
 353 static int sa1100_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 354 {
 355         int ret;
 356
 357         spin_lock_irq(&sa1100_rtc_lock);
 358         ret = rtc_update_alarm(&alrm->time);
 359         if (ret == 0) {
 360                 if (alrm->enabled)
 361                         RTSR |= RTSR_ALE;
 362                 else
 363                         RTSR &= ~RTSR_ALE;
 364         }
 365         spin_unlock_irq(&sa1100_rtc_lock);
 366
 367         return ret;
 368 }
 369
 370 static int sa1100_rtc_proc(struct device *dev, struct seq_file *seq)
 371 {
 372         struct rtc_device *rtc = (struct rtc_device *)dev;
 373
 374         seq_printf(seq, "trim/divider\t: 0x%08x\n", (u32) RTTR);
 375         seq_printf(seq, "update_IRQ\t: %s\n",
 376                         (RTSR & RTSR_HZE) ? "yes" : "no");
 377         seq_printf(seq, "periodic_IRQ\t: %s\n",
 378                         (OIER & OIER_E1) ? "yes" : "no");
 379         seq_printf(seq, "periodic_freq\t: %d\n", rtc->irq_freq);
 380         seq_printf(seq, "RTSR\t\t: 0x%08x\n", (u32)RTSR);
 381
 382         return 0;
 383 }
 384
 385 static const struct rtc_class_ops sa1100_rtc_ops = {
 386         .open = sa1100_rtc_open,
 387         .read_callback = sa1100_rtc_read_callback,
 388         .release = sa1100_rtc_release,
 389         .ioctl = sa1100_rtc_ioctl,
 390         .read_time = sa1100_rtc_read_time,
 391         .set_time = sa1100_rtc_set_time,
 392         .read_alarm = sa1100_rtc_read_alarm,
 393         .set_alarm = sa1100_rtc_set_alarm,
 394         .proc = sa1100_rtc_proc,
 395         .alarm_irq_enable = sa1100_rtc_alarm_irq_enable,
 396 };
 397
 398 static int sa1100_rtc_probe(struct platform_device *pdev)
 399 {
 400         struct rtc_device *rtc;
 401
 402         timer_freq = get_clock_tick_rate();
 403
 404         /*
 405          * According to the manual we should be able to let RTTR be zero
 406          * and then a default diviser for a 32.768KHz clock is used.
 407          * Apparently this doesn't work, at least for my SA1110 rev 5.
 408          * If the clock divider is uninitialized then reset it to the
 409          * default value to get the 1Hz clock.
 410          */
 411         if (RTTR == 0) {
 412                 RTTR = RTC_DEF_DIVIDER + (RTC_DEF_TRIM << 16);
 413                 dev_warn(&pdev->dev, "warning: "
 414                         "initializing default clock divider/trim value\n");
 415                 /* The current RTC value probably doesn't make sense either */
 416                 RCNR = 0;
 417         }
 418
 419         device_init_wakeup(&pdev->dev, 1);
 420
 421         rtc = rtc_device_register(pdev->name, &pdev->dev, &sa1100_rtc_ops,
 422                 THIS_MODULE);
 423
 424         if (IS_ERR(rtc))
 425                 return PTR_ERR(rtc);
 426
 427         platform_set_drvdata(pdev, rtc);
 428
 429         /* Set the irq_freq */
 430         /*TODO: Find out who is messing with this value after we initialize
 431          * it here.*/
 432         rtc->irq_freq = RTC_FREQ;
 433
 434         /* Fix for a nasty initialization problem the in SA11xx RTSR register.
 435          * See also the comments in sa1100_rtc_interrupt().
 436          *
 437          * Sometimes bit 1 of the RTSR (RTSR_HZ) will wake up 1, which means an
 438          * interrupt pending, even though interrupts were never enabled.
 439          * In this case, this bit it must be reset before enabling
 440          * interruptions to avoid a nonexistent interrupt to occur.
 441          *
 442          * In principle, the same problem would apply to bit 0, although it has
 443          * never been observed to happen.
 444          *
 445          * This issue is addressed both here and in sa1100_rtc_interrupt().
 446          * If the issue is not addressed here, in the times when the processor
 447          * wakes up with the bit set there will be one spurious interrupt.
 448          *
 449          * The issue is also dealt with in sa1100_rtc_interrupt() to be on the
 450          * safe side, once the condition that lead to this strange
 451          * initialization is unknown and could in principle happen during
 452          * normal processing.
 453          *
 454          * Notice that clearing bit 1 and 0 is accomplished by writting ONES to
 455          * the corresponding bits in RTSR. */
 456         RTSR = RTSR_AL | RTSR_HZ;
 457
 458         return 0;
 459 }
 460
 461 static int sa1100_rtc_remove(struct platform_device *pdev)
 462 {
 463         struct rtc_device *rtc = platform_get_drvdata(pdev);
 464
 465         if (rtc)
 466                 rtc_device_unregister(rtc);
 467
 468         return 0;
 469 }
 470
 471 #ifdef CONFIG_PM
 472 static int sa1100_rtc_suspend(struct device *dev)
 473 {
 474         if (device_may_wakeup(dev))
 475                 enable_irq_wake(IRQ_RTCAlrm);
 476         return 0;
 477 }
 478
 479 static int sa1100_rtc_resume(struct device *dev)
 480 {
 481         if (device_may_wakeup(dev))
 482                 disable_irq_wake(IRQ_RTCAlrm);
 483         return 0;
 484 }
 485
 486 static const struct dev_pm_ops sa1100_rtc_pm_ops = {
 487         .suspend        = sa1100_rtc_suspend,
 488         .resume         = sa1100_rtc_resume,
 489 };
 490 #endif
 491
 492 static struct platform_driver sa1100_rtc_driver = {
 493         .probe          = sa1100_rtc_probe,
 494         .remove         = sa1100_rtc_remove,
 495         .driver         = {
 496                 .name   = "sa1100-rtc",
 497 #ifdef CONFIG_PM
 498                 .pm     = &sa1100_rtc_pm_ops,
 499 #endif
 500         },
 501 };
 502
 503 static int __init sa1100_rtc_init(void)
 504 {
 505         return platform_driver_register(&sa1100_rtc_driver);
 506 }
 507
 508 static void __exit sa1100_rtc_exit(void)
 509 {
 510         platform_driver_unregister(&sa1100_rtc_driver);
 511 }
 512
 513 module_init(sa1100_rtc_init);
 514 module_exit(sa1100_rtc_exit);
 515
 516 MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
 517 MODULE_DESCRIPTION("SA11x0/PXA2xx Realtime Clock Driver (RTC)");
 518 MODULE_LICENSE("GPL");
 519 MODULE_ALIAS("platform:sa1100-rtc");