drivers/rtc/rtc-at91rm9200.c

   1 /*
   2  *      Real Time Clock interface for Linux on Atmel AT91RM9200
   3  *
   4  *      Copyright (C) 2002 Rick Bronson
   5  *
   6  *      Converted to RTC class model by Andrew Victor
   7  *
   8  *      Ported to Linux 2.6 by Steven Scholz
   9  *      Based on s3c2410-rtc.c Simtec Electronics
  10  *
  11  *      Based on sa1100-rtc.c by Nils Faerber
  12  *      Based on rtc.c by Paul Gortmaker
  13  *
  14  *      This program is free software; you can redistribute it and/or
  15  *      modify it under the terms of the GNU General Public License
  16  *      as published by the Free Software Foundation; either version
  17  *      2 of the License, or (at your option) any later version.
  18  *
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/kernel.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/time.h>
  25 #include <linux/rtc.h>
  26 #include <linux/bcd.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/ioctl.h>
  29 #include <linux/completion.h>
  30 #include <linux/io.h>
  31 #include <linux/of.h>
  32 #include <linux/of_device.h>
  33
  34 #include <asm/uaccess.h>
  35
  36 #include "rtc-at91rm9200.h"
  37
  38 #define at91_rtc_read(field) \
  39         __raw_readl(at91_rtc_regs + field)
  40 #define at91_rtc_write(field, val) \
  41         __raw_writel((val), at91_rtc_regs + field)
  42
  43 #define AT91_RTC_EPOCH          1900UL  /* just like arch/arm/common/rtctime.c */
  44
  45 struct at91_rtc_config {
  46 };
  47
  48 static const struct at91_rtc_config *at91_rtc_config;
  49 static DECLARE_COMPLETION(at91_rtc_updated);
  50 static unsigned int at91_alarm_year = AT91_RTC_EPOCH;
  51 static void __iomem *at91_rtc_regs;
  52 static int irq;
  53
  54 static void at91_rtc_write_ier(u32 mask)
  55 {
  56         at91_rtc_write(AT91_RTC_IER, mask);
  57 }
  58
  59 static void at91_rtc_write_idr(u32 mask)
  60 {
  61         at91_rtc_write(AT91_RTC_IDR, mask);
  62 }
  63
  64 static u32 at91_rtc_read_imr(void)
  65 {
  66         return at91_rtc_read(AT91_RTC_IMR);
  67 }
  68
  69 /*
  70  * Decode time/date into rtc_time structure
  71  */
  72 static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
  73                                 struct rtc_time *tm)
  74 {
  75         unsigned int time, date;
  76
  77         /* must read twice in case it changes */
  78         do {
  79                 time = at91_rtc_read(timereg);
  80                 date = at91_rtc_read(calreg);
  81         } while ((time != at91_rtc_read(timereg)) ||
  82                         (date != at91_rtc_read(calreg)));
  83
  84         tm->tm_sec  = bcd2bin((time & AT91_RTC_SEC) >> 0);
  85         tm->tm_min  = bcd2bin((time & AT91_RTC_MIN) >> 8);
  86         tm->tm_hour = bcd2bin((time & AT91_RTC_HOUR) >> 16);
  87
  88         /*
  89          * The Calendar Alarm register does not have a field for
  90          * the year - so these will return an invalid value.  When an
  91          * alarm is set, at91_alarm_year will store the current year.
  92          */
  93         tm->tm_year  = bcd2bin(date & AT91_RTC_CENT) * 100;     /* century */
  94         tm->tm_year += bcd2bin((date & AT91_RTC_YEAR) >> 8);    /* year */
  95
  96         tm->tm_wday = bcd2bin((date & AT91_RTC_DAY) >> 21) - 1; /* day of the week [0-6], Sunday=0 */
  97         tm->tm_mon  = bcd2bin((date & AT91_RTC_MONTH) >> 16) - 1;
  98         tm->tm_mday = bcd2bin((date & AT91_RTC_DATE) >> 24);
  99 }
 100
 101 /*
 102  * Read current time and date in RTC
 103  */
 104 static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
 105 {
 106         at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
 107         tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
 108         tm->tm_year = tm->tm_year - 1900;
 109
 110         dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
 111                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 112                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 113
 114         return 0;
 115 }
 116
 117 /*
 118  * Set current time and date in RTC
 119  */
 120 static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
 121 {
 122         unsigned long cr;
 123
 124         dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
 125                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 126                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 127
 128         /* Stop Time/Calendar from counting */
 129         cr = at91_rtc_read(AT91_RTC_CR);
 130         at91_rtc_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);
 131
 132         at91_rtc_write_ier(AT91_RTC_ACKUPD);
 133         wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
 134         at91_rtc_write_idr(AT91_RTC_ACKUPD);
 135
 136         at91_rtc_write(AT91_RTC_TIMR,
 137                           bin2bcd(tm->tm_sec) << 0
 138                         | bin2bcd(tm->tm_min) << 8
 139                         | bin2bcd(tm->tm_hour) << 16);
 140
 141         at91_rtc_write(AT91_RTC_CALR,
 142                           bin2bcd((tm->tm_year + 1900) / 100)   /* century */
 143                         | bin2bcd(tm->tm_year % 100) << 8       /* year */
 144                         | bin2bcd(tm->tm_mon + 1) << 16         /* tm_mon starts at zero */
 145                         | bin2bcd(tm->tm_wday + 1) << 21        /* day of the week [0-6], Sunday=0 */
 146                         | bin2bcd(tm->tm_mday) << 24);
 147
 148         /* Restart Time/Calendar */
 149         cr = at91_rtc_read(AT91_RTC_CR);
 150         at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
 151
 152         return 0;
 153 }
 154
 155 /*
 156  * Read alarm time and date in RTC
 157  */
 158 static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
 159 {
 160         struct rtc_time *tm = &alrm->time;
 161
 162         at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
 163         tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
 164         tm->tm_year = at91_alarm_year - 1900;
 165
 166         alrm->enabled = (at91_rtc_read_imr() & AT91_RTC_ALARM)
 167                         ? 1 : 0;
 168
 169         dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
 170                 1900 + tm->tm_year, tm->tm_mon, tm->tm_mday,
 171                 tm->tm_hour, tm->tm_min, tm->tm_sec);
 172
 173         return 0;
 174 }
 175
 176 /*
 177  * Set alarm time and date in RTC
 178  */
 179 static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
 180 {
 181         struct rtc_time tm;
 182
 183         at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, &tm);
 184
 185         at91_alarm_year = tm.tm_year;
 186
 187         tm.tm_hour = alrm->time.tm_hour;
 188         tm.tm_min = alrm->time.tm_min;
 189         tm.tm_sec = alrm->time.tm_sec;
 190
 191         at91_rtc_write_idr(AT91_RTC_ALARM);
 192         at91_rtc_write(AT91_RTC_TIMALR,
 193                   bin2bcd(tm.tm_sec) << 0
 194                 | bin2bcd(tm.tm_min) << 8
 195                 | bin2bcd(tm.tm_hour) << 16
 196                 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
 197         at91_rtc_write(AT91_RTC_CALALR,
 198                   bin2bcd(tm.tm_mon + 1) << 16          /* tm_mon starts at zero */
 199                 | bin2bcd(tm.tm_mday) << 24
 200                 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
 201
 202         if (alrm->enabled) {
 203                 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
 204                 at91_rtc_write_ier(AT91_RTC_ALARM);
 205         }
 206
 207         dev_dbg(dev, "%s(): %4d-%02d-%02d %02d:%02d:%02d\n", __func__,
 208                 at91_alarm_year, tm.tm_mon, tm.tm_mday, tm.tm_hour,
 209                 tm.tm_min, tm.tm_sec);
 210
 211         return 0;
 212 }
 213
 214 static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 215 {
 216         dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);
 217
 218         if (enabled) {
 219                 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
 220                 at91_rtc_write_ier(AT91_RTC_ALARM);
 221         } else
 222                 at91_rtc_write_idr(AT91_RTC_ALARM);
 223
 224         return 0;
 225 }
 226 /*
 227  * Provide additional RTC information in /proc/driver/rtc
 228  */
 229 static int at91_rtc_proc(struct device *dev, struct seq_file *seq)
 230 {
 231         unsigned long imr = at91_rtc_read_imr();
 232
 233         seq_printf(seq, "update_IRQ\t: %s\n",
 234                         (imr & AT91_RTC_ACKUPD) ? "yes" : "no");
 235         seq_printf(seq, "periodic_IRQ\t: %s\n",
 236                         (imr & AT91_RTC_SECEV) ? "yes" : "no");
 237
 238         return 0;
 239 }
 240
 241 /*
 242  * IRQ handler for the RTC
 243  */
 244 static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
 245 {
 246         struct platform_device *pdev = dev_id;
 247         struct rtc_device *rtc = platform_get_drvdata(pdev);
 248         unsigned int rtsr;
 249         unsigned long events = 0;
 250
 251         rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read_imr();
 252         if (rtsr) {             /* this interrupt is shared!  Is it ours? */
 253                 if (rtsr & AT91_RTC_ALARM)
 254                         events |= (RTC_AF | RTC_IRQF);
 255                 if (rtsr & AT91_RTC_SECEV)
 256                         events |= (RTC_UF | RTC_IRQF);
 257                 if (rtsr & AT91_RTC_ACKUPD)
 258                         complete(&at91_rtc_updated);
 259
 260                 at91_rtc_write(AT91_RTC_SCCR, rtsr);    /* clear status reg */
 261
 262                 rtc_update_irq(rtc, 1, events);
 263
 264                 dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n", __func__,
 265                         events >> 8, events & 0x000000FF);
 266
 267                 return IRQ_HANDLED;
 268         }
 269         return IRQ_NONE;                /* not handled */
 270 }
 271
 272 static const struct at91_rtc_config at91rm9200_config = {
 273 };
 274
 275 #ifdef CONFIG_OF
 276 static const struct of_device_id at91_rtc_dt_ids[] = {
 277         {
 278                 .compatible = "atmel,at91rm9200-rtc",
 279                 .data = &at91rm9200_config,
 280         }, {
 281                 /* sentinel */
 282         }
 283 };
 284 MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
 285 #endif
 286
 287 static const struct at91_rtc_config *
 288 at91_rtc_get_config(struct platform_device *pdev)
 289 {
 290         const struct of_device_id *match;
 291
 292         if (pdev->dev.of_node) {
 293                 match = of_match_node(at91_rtc_dt_ids, pdev->dev.of_node);
 294                 if (!match)
 295                         return NULL;
 296                 return (const struct at91_rtc_config *)match->data;
 297         }
 298
 299         return &at91rm9200_config;
 300 }
 301
 302 static const struct rtc_class_ops at91_rtc_ops = {
 303         .read_time      = at91_rtc_readtime,
 304         .set_time       = at91_rtc_settime,
 305         .read_alarm     = at91_rtc_readalarm,
 306         .set_alarm      = at91_rtc_setalarm,
 307         .proc           = at91_rtc_proc,
 308         .alarm_irq_enable = at91_rtc_alarm_irq_enable,
 309 };
 310
 311 /*
 312  * Initialize and install RTC driver
 313  */
 314 static int __init at91_rtc_probe(struct platform_device *pdev)
 315 {
 316         struct rtc_device *rtc;
 317         struct resource *regs;
 318         int ret = 0;
 319
 320         at91_rtc_config = at91_rtc_get_config(pdev);
 321         if (!at91_rtc_config)
 322                 return -ENODEV;
 323
 324         regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 325         if (!regs) {
 326                 dev_err(&pdev->dev, "no mmio resource defined\n");
 327                 return -ENXIO;
 328         }
 329
 330         irq = platform_get_irq(pdev, 0);
 331         if (irq < 0) {
 332                 dev_err(&pdev->dev, "no irq resource defined\n");
 333                 return -ENXIO;
 334         }
 335
 336         at91_rtc_regs = ioremap(regs->start, resource_size(regs));
 337         if (!at91_rtc_regs) {
 338                 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
 339                 return -ENOMEM;
 340         }
 341
 342         at91_rtc_write(AT91_RTC_CR, 0);
 343         at91_rtc_write(AT91_RTC_MR, 0);         /* 24 hour mode */
 344
 345         /* Disable all interrupts */
 346         at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
 347                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
 348                                         AT91_RTC_CALEV);
 349
 350         ret = request_irq(irq, at91_rtc_interrupt,
 351                                 IRQF_SHARED,
 352                                 "at91_rtc", pdev);
 353         if (ret) {
 354                 dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
 355                 goto err_unmap;
 356         }
 357
 358         /* cpu init code should really have flagged this device as
 359          * being wake-capable; if it didn't, do that here.
 360          */
 361         if (!device_can_wakeup(&pdev->dev))
 362                 device_init_wakeup(&pdev->dev, 1);
 363
 364         rtc = rtc_device_register(pdev->name, &pdev->dev,
 365                                 &at91_rtc_ops, THIS_MODULE);
 366         if (IS_ERR(rtc)) {
 367                 ret = PTR_ERR(rtc);
 368                 goto err_free_irq;
 369         }
 370         platform_set_drvdata(pdev, rtc);
 371
 372         dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
 373         return 0;
 374
 375 err_free_irq:
 376         free_irq(irq, pdev);
 377 err_unmap:
 378         iounmap(at91_rtc_regs);
 379
 380         return ret;
 381 }
 382
 383 /*
 384  * Disable and remove the RTC driver
 385  */
 386 static int __exit at91_rtc_remove(struct platform_device *pdev)
 387 {
 388         struct rtc_device *rtc = platform_get_drvdata(pdev);
 389
 390         /* Disable all interrupts */
 391         at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
 392                                         AT91_RTC_SECEV | AT91_RTC_TIMEV |
 393                                         AT91_RTC_CALEV);
 394         free_irq(irq, pdev);
 395
 396         rtc_device_unregister(rtc);
 397         iounmap(at91_rtc_regs);
 398         platform_set_drvdata(pdev, NULL);
 399
 400         return 0;
 401 }
 402
 403 #ifdef CONFIG_PM_SLEEP
 404
 405 /* AT91RM9200 RTC Power management control */
 406
 407 static u32 at91_rtc_imr;
 408
 409 static int at91_rtc_suspend(struct device *dev)
 410 {
 411         /* this IRQ is shared with DBGU and other hardware which isn't
 412          * necessarily doing PM like we are...
 413          */
 414         at91_rtc_imr = at91_rtc_read_imr()
 415                         & (AT91_RTC_ALARM|AT91_RTC_SECEV);
 416         if (at91_rtc_imr) {
 417                 if (device_may_wakeup(dev))
 418                         enable_irq_wake(irq);
 419                 else
 420                         at91_rtc_write_idr(at91_rtc_imr);
 421         }
 422         return 0;
 423 }
 424
 425 static int at91_rtc_resume(struct device *dev)
 426 {
 427         if (at91_rtc_imr) {
 428                 if (device_may_wakeup(dev))
 429                         disable_irq_wake(irq);
 430                 else
 431                         at91_rtc_write_ier(at91_rtc_imr);
 432         }
 433         return 0;
 434 }
 435 #endif
 436
 437 static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
 438
 439 static struct platform_driver at91_rtc_driver = {
 440         .remove         = __exit_p(at91_rtc_remove),
 441         .driver         = {
 442                 .name   = "at91_rtc",
 443                 .owner  = THIS_MODULE,
 444                 .pm     = &at91_rtc_pm_ops,
 445                 .of_match_table = of_match_ptr(at91_rtc_dt_ids),
 446         },
 447 };
 448
 449 module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);
 450
 451 MODULE_AUTHOR("Rick Bronson");
 452 MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
 453 MODULE_LICENSE("GPL");
 454 MODULE_ALIAS("platform:at91_rtc");