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