drivers/rtc/rtc-bfin.c

   1 /*
   2  * Blackfin On-Chip Real Time Clock Driver
   3  *  Supports BF52[257]/BF53[123]/BF53[467]/BF54[24789]
   4  *
   5  * Copyright 2004-2008 Analog Devices Inc.
   6  *
   7  * Enter bugs at http://blackfin.uclinux.org/
   8  *
   9  * Licensed under the GPL-2 or later.
  10  */
  11
  12 /* The biggest issue we deal with in this driver is that register writes are
  13  * synced to the RTC frequency of 1Hz.  So if you write to a register and
  14  * attempt to write again before the first write has completed, the new write
  15  * is simply discarded.  This can easily be troublesome if userspace disables
  16  * one event (say periodic) and then right after enables an event (say alarm).
  17  * Since all events are maintained in the same interrupt mask register, if
  18  * we wrote to it to disable the first event and then wrote to it again to
  19  * enable the second event, that second event would not be enabled as the
  20  * write would be discarded and things quickly fall apart.
  21  *
  22  * To keep this delay from significantly degrading performance (we, in theory,
  23  * would have to sleep for up to 1 second everytime we wanted to write a
  24  * register), we only check the write pending status before we start to issue
  25  * a new write.  We bank on the idea that it doesnt matter when the sync
  26  * happens so long as we don't attempt another write before it does.  The only
  27  * time userspace would take this penalty is when they try and do multiple
  28  * operations right after another ... but in this case, they need to take the
  29  * sync penalty, so we should be OK.
  30  *
  31  * Also note that the RTC_ISTAT register does not suffer this penalty; its
  32  * writes to clear status registers complete immediately.
  33  */
  34
  35 /* It may seem odd that there is no SWCNT code in here (which would be exposed
  36  * via the periodic interrupt event, or PIE).  Since the Blackfin RTC peripheral
  37  * runs in units of seconds (N/HZ) but the Linux framework runs in units of HZ
  38  * (2^N HZ), there is no point in keeping code that only provides 1 HZ PIEs.
  39  * The same exact behavior can be accomplished by using the update interrupt
  40  * event (UIE).  Maybe down the line the RTC peripheral will suck less in which
  41  * case we can re-introduce PIE support.
  42  */
  43
  44 #include <linux/bcd.h>
  45 #include <linux/completion.h>
  46 #include <linux/delay.h>
  47 #include <linux/init.h>
  48 #include <linux/interrupt.h>
  49 #include <linux/kernel.h>
  50 #include <linux/module.h>
  51 #include <linux/platform_device.h>
  52 #include <linux/rtc.h>
  53 #include <linux/seq_file.h>
  54
  55 #include <asm/blackfin.h>
  56
  57 #define dev_dbg_stamp(dev) dev_dbg(dev, "%s:%i: here i am\n", __func__, __LINE__)
  58
  59 struct bfin_rtc {
  60         struct rtc_device *rtc_dev;
  61         struct rtc_time rtc_alarm;
  62         u16 rtc_wrote_regs;
  63 };
  64
  65 /* Bit values for the ISTAT / ICTL registers */
  66 #define RTC_ISTAT_WRITE_COMPLETE  0x8000
  67 #define RTC_ISTAT_WRITE_PENDING   0x4000
  68 #define RTC_ISTAT_ALARM_DAY       0x0040
  69 #define RTC_ISTAT_24HR            0x0020
  70 #define RTC_ISTAT_HOUR            0x0010
  71 #define RTC_ISTAT_MIN             0x0008
  72 #define RTC_ISTAT_SEC             0x0004
  73 #define RTC_ISTAT_ALARM           0x0002
  74 #define RTC_ISTAT_STOPWATCH       0x0001
  75
  76 /* Shift values for RTC_STAT register */
  77 #define DAY_BITS_OFF    17
  78 #define HOUR_BITS_OFF   12
  79 #define MIN_BITS_OFF    6
  80 #define SEC_BITS_OFF    0
  81
  82 /* Some helper functions to convert between the common RTC notion of time
  83  * and the internal Blackfin notion that is encoded in 32bits.
  84  */
  85 static inline u32 rtc_time_to_bfin(unsigned long now)
  86 {
  87         u32 sec  = (now % 60);
  88         u32 min  = (now % (60 * 60)) / 60;
  89         u32 hour = (now % (60 * 60 * 24)) / (60 * 60);
  90         u32 days = (now / (60 * 60 * 24));
  91         return (sec  << SEC_BITS_OFF) +
  92                (min  << MIN_BITS_OFF) +
  93                (hour << HOUR_BITS_OFF) +
  94                (days << DAY_BITS_OFF);
  95 }
  96 static inline unsigned long rtc_bfin_to_time(u32 rtc_bfin)
  97 {
  98         return (((rtc_bfin >> SEC_BITS_OFF)  & 0x003F)) +
  99                (((rtc_bfin >> MIN_BITS_OFF)  & 0x003F) * 60) +
 100                (((rtc_bfin >> HOUR_BITS_OFF) & 0x001F) * 60 * 60) +
 101                (((rtc_bfin >> DAY_BITS_OFF)  & 0x7FFF) * 60 * 60 * 24);
 102 }
 103 static inline void rtc_bfin_to_tm(u32 rtc_bfin, struct rtc_time *tm)
 104 {
 105         rtc_time_to_tm(rtc_bfin_to_time(rtc_bfin), tm);
 106 }
 107
 108 /**
 109  *      bfin_rtc_sync_pending - make sure pending writes have complete
 110  *
 111  * Wait for the previous write to a RTC register to complete.
 112  * Unfortunately, we can't sleep here as that introduces a race condition when
 113  * turning on interrupt events.  Consider this:
 114  *  - process sets alarm
 115  *  - process enables alarm
 116  *  - process sleeps while waiting for rtc write to sync
 117  *  - interrupt fires while process is sleeping
 118  *  - interrupt acks the event by writing to ISTAT
 119  *  - interrupt sets the WRITE PENDING bit
 120  *  - interrupt handler finishes
 121  *  - process wakes up, sees WRITE PENDING bit set, goes to sleep
 122  *  - interrupt fires while process is sleeping
 123  * If anyone can point out the obvious solution here, i'm listening :).  This
 124  * shouldn't be an issue on an SMP or preempt system as this function should
 125  * only be called with the rtc lock held.
 126  *
 127  * Other options:
 128  *  - disable PREN so the sync happens at 32.768kHZ ... but this changes the
 129  *    inc rate for all RTC registers from 1HZ to 32.768kHZ ...
 130  *  - use the write complete IRQ
 131  */
 132 /*
 133 static void bfin_rtc_sync_pending_polled(void)
 134 {
 135         while (!(bfin_read_RTC_ISTAT() & RTC_ISTAT_WRITE_COMPLETE))
 136                 if (!(bfin_read_RTC_ISTAT() & RTC_ISTAT_WRITE_PENDING))
 137                         break;
 138         bfin_write_RTC_ISTAT(RTC_ISTAT_WRITE_COMPLETE);
 139 }
 140 */
 141 static DECLARE_COMPLETION(bfin_write_complete);
 142 static void bfin_rtc_sync_pending(struct device *dev)
 143 {
 144         dev_dbg_stamp(dev);
 145         while (bfin_read_RTC_ISTAT() & RTC_ISTAT_WRITE_PENDING)
 146                 wait_for_completion_timeout(&bfin_write_complete, HZ * 5);
 147         dev_dbg_stamp(dev);
 148 }
 149
 150 /**
 151  *      bfin_rtc_reset - set RTC to sane/known state
 152  *
 153  * Initialize the RTC.  Enable pre-scaler to scale RTC clock
 154  * to 1Hz and clear interrupt/status registers.
 155  */
 156 static void bfin_rtc_reset(struct device *dev, u16 rtc_ictl)
 157 {
 158         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 159         dev_dbg_stamp(dev);
 160         bfin_rtc_sync_pending(dev);
 161         bfin_write_RTC_PREN(0x1);
 162         bfin_write_RTC_ICTL(rtc_ictl);
 163         bfin_write_RTC_ALARM(0);
 164         bfin_write_RTC_ISTAT(0xFFFF);
 165         rtc->rtc_wrote_regs = 0;
 166 }
 167
 168 /**
 169  *      bfin_rtc_interrupt - handle interrupt from RTC
 170  *
 171  * Since we handle all RTC events here, we have to make sure the requested
 172  * interrupt is enabled (in RTC_ICTL) as the event status register (RTC_ISTAT)
 173  * always gets updated regardless of the interrupt being enabled.  So when one
 174  * even we care about (e.g. stopwatch) goes off, we don't want to turn around
 175  * and say that other events have happened as well (e.g. second).  We do not
 176  * have to worry about pending writes to the RTC_ICTL register as interrupts
 177  * only fire if they are enabled in the RTC_ICTL register.
 178  */
 179 static irqreturn_t bfin_rtc_interrupt(int irq, void *dev_id)
 180 {
 181         struct device *dev = dev_id;
 182         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 183         unsigned long events = 0;
 184         bool write_complete = false;
 185         u16 rtc_istat, rtc_ictl;
 186
 187         dev_dbg_stamp(dev);
 188
 189         rtc_istat = bfin_read_RTC_ISTAT();
 190         rtc_ictl = bfin_read_RTC_ICTL();
 191
 192         if (rtc_istat & RTC_ISTAT_WRITE_COMPLETE) {
 193                 bfin_write_RTC_ISTAT(RTC_ISTAT_WRITE_COMPLETE);
 194                 write_complete = true;
 195                 complete(&bfin_write_complete);
 196         }
 197
 198         if (rtc_ictl & (RTC_ISTAT_ALARM | RTC_ISTAT_ALARM_DAY)) {
 199                 if (rtc_istat & (RTC_ISTAT_ALARM | RTC_ISTAT_ALARM_DAY)) {
 200                         bfin_write_RTC_ISTAT(RTC_ISTAT_ALARM | RTC_ISTAT_ALARM_DAY);
 201                         events |= RTC_AF | RTC_IRQF;
 202                 }
 203         }
 204
 205         if (rtc_ictl & RTC_ISTAT_SEC) {
 206                 if (rtc_istat & RTC_ISTAT_SEC) {
 207                         bfin_write_RTC_ISTAT(RTC_ISTAT_SEC);
 208                         events |= RTC_UF | RTC_IRQF;
 209                 }
 210         }
 211
 212         if (events)
 213                 rtc_update_irq(rtc->rtc_dev, 1, events);
 214
 215         if (write_complete || events)
 216                 return IRQ_HANDLED;
 217         else
 218                 return IRQ_NONE;
 219 }
 220
 221 static int bfin_rtc_open(struct device *dev)
 222 {
 223         int ret;
 224
 225         dev_dbg_stamp(dev);
 226
 227         ret = request_irq(IRQ_RTC, bfin_rtc_interrupt, IRQF_SHARED, to_platform_device(dev)->name, dev);
 228         if (!ret)
 229                 bfin_rtc_reset(dev, RTC_ISTAT_WRITE_COMPLETE);
 230
 231         return ret;
 232 }
 233
 234 static void bfin_rtc_release(struct device *dev)
 235 {
 236         dev_dbg_stamp(dev);
 237         bfin_rtc_reset(dev, 0);
 238         free_irq(IRQ_RTC, dev);
 239 }
 240
 241 static void bfin_rtc_int_set(u16 rtc_int)
 242 {
 243         bfin_write_RTC_ISTAT(rtc_int);
 244         bfin_write_RTC_ICTL(bfin_read_RTC_ICTL() | rtc_int);
 245 }
 246 static void bfin_rtc_int_clear(u16 rtc_int)
 247 {
 248         bfin_write_RTC_ICTL(bfin_read_RTC_ICTL() & rtc_int);
 249 }
 250 static void bfin_rtc_int_set_alarm(struct bfin_rtc *rtc)
 251 {
 252         /* Blackfin has different bits for whether the alarm is
 253          * more than 24 hours away.
 254          */
 255         bfin_rtc_int_set(rtc->rtc_alarm.tm_yday == -1 ? RTC_ISTAT_ALARM : RTC_ISTAT_ALARM_DAY);
 256 }
 257 static int bfin_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
 258 {
 259         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 260         int ret = 0;
 261
 262         dev_dbg_stamp(dev);
 263
 264         bfin_rtc_sync_pending(dev);
 265
 266         switch (cmd) {
 267         case RTC_UIE_ON:
 268                 dev_dbg_stamp(dev);
 269                 bfin_rtc_int_set(RTC_ISTAT_SEC);
 270                 break;
 271         case RTC_UIE_OFF:
 272                 dev_dbg_stamp(dev);
 273                 bfin_rtc_int_clear(~RTC_ISTAT_SEC);
 274                 break;
 275
 276         case RTC_AIE_ON:
 277                 dev_dbg_stamp(dev);
 278                 bfin_rtc_int_set_alarm(rtc);
 279                 break;
 280         case RTC_AIE_OFF:
 281                 dev_dbg_stamp(dev);
 282                 bfin_rtc_int_clear(~(RTC_ISTAT_ALARM | RTC_ISTAT_ALARM_DAY));
 283                 break;
 284
 285         default:
 286                 dev_dbg_stamp(dev);
 287                 ret = -ENOIOCTLCMD;
 288         }
 289
 290         return ret;
 291 }
 292
 293 static int bfin_rtc_read_time(struct device *dev, struct rtc_time *tm)
 294 {
 295         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 296
 297         dev_dbg_stamp(dev);
 298
 299         if (rtc->rtc_wrote_regs & 0x1)
 300                 bfin_rtc_sync_pending(dev);
 301
 302         rtc_bfin_to_tm(bfin_read_RTC_STAT(), tm);
 303
 304         return 0;
 305 }
 306
 307 static int bfin_rtc_set_time(struct device *dev, struct rtc_time *tm)
 308 {
 309         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 310         int ret;
 311         unsigned long now;
 312
 313         dev_dbg_stamp(dev);
 314
 315         ret = rtc_tm_to_time(tm, &now);
 316         if (ret == 0) {
 317                 if (rtc->rtc_wrote_regs & 0x1)
 318                         bfin_rtc_sync_pending(dev);
 319                 bfin_write_RTC_STAT(rtc_time_to_bfin(now));
 320                 rtc->rtc_wrote_regs = 0x1;
 321         }
 322
 323         return ret;
 324 }
 325
 326 static int bfin_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 327 {
 328         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 329         dev_dbg_stamp(dev);
 330         alrm->time = rtc->rtc_alarm;
 331         bfin_rtc_sync_pending(dev);
 332         alrm->enabled = !!(bfin_read_RTC_ICTL() & (RTC_ISTAT_ALARM | RTC_ISTAT_ALARM_DAY));
 333         return 0;
 334 }
 335
 336 static int bfin_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
 337 {
 338         struct bfin_rtc *rtc = dev_get_drvdata(dev);
 339         unsigned long rtc_alarm;
 340
 341         dev_dbg_stamp(dev);
 342
 343         if (rtc_tm_to_time(&alrm->time, &rtc_alarm))
 344                 return -EINVAL;
 345
 346         rtc->rtc_alarm = alrm->time;
 347
 348         bfin_rtc_sync_pending(dev);
 349         bfin_write_RTC_ALARM(rtc_time_to_bfin(rtc_alarm));
 350         if (alrm->enabled)
 351                 bfin_rtc_int_set_alarm(rtc);
 352
 353         return 0;
 354 }
 355
 356 static int bfin_rtc_proc(struct device *dev, struct seq_file *seq)
 357 {
 358 #define yesno(x) ((x) ? "yes" : "no")
 359         u16 ictl = bfin_read_RTC_ICTL();
 360         dev_dbg_stamp(dev);
 361         seq_printf(seq,
 362                 "alarm_IRQ\t: %s\n"
 363                 "wkalarm_IRQ\t: %s\n"
 364                 "seconds_IRQ\t: %s\n",
 365                 yesno(ictl & RTC_ISTAT_ALARM),
 366                 yesno(ictl & RTC_ISTAT_ALARM_DAY),
 367                 yesno(ictl & RTC_ISTAT_SEC));
 368         return 0;
 369 #undef yesno
 370 }
 371
 372 static struct rtc_class_ops bfin_rtc_ops = {
 373         .open          = bfin_rtc_open,
 374         .release       = bfin_rtc_release,
 375         .ioctl         = bfin_rtc_ioctl,
 376         .read_time     = bfin_rtc_read_time,
 377         .set_time      = bfin_rtc_set_time,
 378         .read_alarm    = bfin_rtc_read_alarm,
 379         .set_alarm     = bfin_rtc_set_alarm,
 380         .proc          = bfin_rtc_proc,
 381 };
 382
 383 static int __devinit bfin_rtc_probe(struct platform_device *pdev)
 384 {
 385         struct bfin_rtc *rtc;
 386         int ret = 0;
 387
 388         dev_dbg_stamp(&pdev->dev);
 389
 390         rtc = kzalloc(sizeof(*rtc), GFP_KERNEL);
 391         if (unlikely(!rtc))
 392                 return -ENOMEM;
 393
 394         rtc->rtc_dev = rtc_device_register(pdev->name, &pdev->dev, &bfin_rtc_ops, THIS_MODULE);
 395         if (IS_ERR(rtc)) {
 396                 ret = PTR_ERR(rtc->rtc_dev);
 397                 goto err;
 398         }
 399
 400         /* see comment at top of file about stopwatch/PIE */
 401         bfin_write_RTC_SWCNT(0);
 402
 403         platform_set_drvdata(pdev, rtc);
 404
 405         device_init_wakeup(&pdev->dev, 1);
 406
 407         return 0;
 408
 409  err:
 410         kfree(rtc);
 411         return ret;
 412 }
 413
 414 static int __devexit bfin_rtc_remove(struct platform_device *pdev)
 415 {
 416         struct bfin_rtc *rtc = platform_get_drvdata(pdev);
 417
 418         rtc_device_unregister(rtc->rtc_dev);
 419         platform_set_drvdata(pdev, NULL);
 420         kfree(rtc);
 421
 422         return 0;
 423 }
 424
 425 #ifdef CONFIG_PM
 426 static int bfin_rtc_suspend(struct platform_device *pdev, pm_message_t state)
 427 {
 428         if (device_may_wakeup(&pdev->dev)) {
 429                 enable_irq_wake(IRQ_RTC);
 430                 bfin_rtc_sync_pending(&pdev->dev);
 431         } else
 432                 bfin_rtc_int_clear(-1);
 433
 434         return 0;
 435 }
 436
 437 static int bfin_rtc_resume(struct platform_device *pdev)
 438 {
 439         if (device_may_wakeup(&pdev->dev))
 440                 disable_irq_wake(IRQ_RTC);
 441         else
 442                 bfin_write_RTC_ISTAT(-1);
 443
 444         return 0;
 445 }
 446 #else
 447 # define bfin_rtc_suspend NULL
 448 # define bfin_rtc_resume  NULL
 449 #endif
 450
 451 static struct platform_driver bfin_rtc_driver = {
 452         .driver         = {
 453                 .name   = "rtc-bfin",
 454                 .owner  = THIS_MODULE,
 455         },
 456         .probe          = bfin_rtc_probe,
 457         .remove         = __devexit_p(bfin_rtc_remove),
 458         .suspend        = bfin_rtc_suspend,
 459         .resume         = bfin_rtc_resume,
 460 };
 461
 462 static int __init bfin_rtc_init(void)
 463 {
 464         return platform_driver_register(&bfin_rtc_driver);
 465 }
 466
 467 static void __exit bfin_rtc_exit(void)
 468 {
 469         platform_driver_unregister(&bfin_rtc_driver);
 470 }
 471
 472 module_init(bfin_rtc_init);
 473 module_exit(bfin_rtc_exit);
 474
 475 MODULE_DESCRIPTION("Blackfin On-Chip Real Time Clock Driver");
 476 MODULE_AUTHOR("Mike Frysinger <vapier@gentoo.org>");
 477 MODULE_LICENSE("GPL");
 478 MODULE_ALIAS("platform:rtc-bfin");