hw/timer/mc146818rtc.c

   1 /*
   2  * QEMU MC146818 RTC emulation
   3  *
   4  * Copyright (c) 2003-2004 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "hw/hw.h"
  25 #include "qemu/timer.h"
  26 #include "sysemu/sysemu.h"
  27 #include "hw/timer/mc146818rtc.h"
  28 #include "qapi/visitor.h"
  29 #include "qapi-event.h"
  30
  31 #ifdef TARGET_I386
  32 #include "hw/i386/apic.h"
  33 #endif
  34
  35 //#define DEBUG_CMOS
  36 //#define DEBUG_COALESCED
  37
  38 #ifdef DEBUG_CMOS
  39 # define CMOS_DPRINTF(format, ...)      printf(format, ## __VA_ARGS__)
  40 #else
  41 # define CMOS_DPRINTF(format, ...)      do { } while (0)
  42 #endif
  43
  44 #ifdef DEBUG_COALESCED
  45 # define DPRINTF_C(format, ...)      printf(format, ## __VA_ARGS__)
  46 #else
  47 # define DPRINTF_C(format, ...)      do { } while (0)
  48 #endif
  49
  50 #define NSEC_PER_SEC    1000000000LL
  51 #define SEC_PER_MIN     60
  52 #define MIN_PER_HOUR    60
  53 #define SEC_PER_HOUR    3600
  54 #define HOUR_PER_DAY    24
  55 #define SEC_PER_DAY     86400
  56
  57 #define RTC_REINJECT_ON_ACK_COUNT 20
  58 #define RTC_CLOCK_RATE            32768
  59 #define UIP_HOLD_LENGTH           (8 * NSEC_PER_SEC / 32768)
  60
  61 #define MC146818_RTC(obj) OBJECT_CHECK(RTCState, (obj), TYPE_MC146818_RTC)
  62
  63 typedef struct RTCState {
  64     ISADevice parent_obj;
  65
  66     MemoryRegion io;
  67     uint8_t cmos_data[128];
  68     uint8_t cmos_index;
  69     int32_t base_year;
  70     uint64_t base_rtc;
  71     uint64_t last_update;
  72     int64_t offset;
  73     qemu_irq irq;
  74     int it_shift;
  75     /* periodic timer */
  76     QEMUTimer *periodic_timer;
  77     int64_t next_periodic_time;
  78     /* update-ended timer */
  79     QEMUTimer *update_timer;
  80     uint64_t next_alarm_time;
  81     uint16_t irq_reinject_on_ack_count;
  82     uint32_t irq_coalesced;
  83     uint32_t period;
  84     QEMUTimer *coalesced_timer;
  85     Notifier clock_reset_notifier;
  86     LostTickPolicy lost_tick_policy;
  87     Notifier suspend_notifier;
  88 } RTCState;
  89
  90 static void rtc_set_time(RTCState *s);
  91 static void rtc_update_time(RTCState *s);
  92 static void rtc_set_cmos(RTCState *s, const struct tm *tm);
  93 static inline int rtc_from_bcd(RTCState *s, int a);
  94 static uint64_t get_next_alarm(RTCState *s);
  95
  96 static inline bool rtc_running(RTCState *s)
  97 {
  98     return (!(s->cmos_data[RTC_REG_B] & REG_B_SET) &&
  99             (s->cmos_data[RTC_REG_A] & 0x70) <= 0x20);
 100 }
 101
 102 static uint64_t get_guest_rtc_ns(RTCState *s)
 103 {
 104     uint64_t guest_rtc;
 105     uint64_t guest_clock = qemu_clock_get_ns(rtc_clock);
 106
 107     guest_rtc = s->base_rtc * NSEC_PER_SEC
 108                  + guest_clock - s->last_update + s->offset;
 109     return guest_rtc;
 110 }
 111
 112 #ifdef TARGET_I386
 113 static void rtc_coalesced_timer_update(RTCState *s)
 114 {
 115     if (s->irq_coalesced == 0) {
 116         timer_del(s->coalesced_timer);
 117     } else {
 118         /* divide each RTC interval to 2 - 8 smaller intervals */
 119         int c = MIN(s->irq_coalesced, 7) + 1;
 120         int64_t next_clock = qemu_clock_get_ns(rtc_clock) +
 121             muldiv64(s->period / c, get_ticks_per_sec(), RTC_CLOCK_RATE);
 122         timer_mod(s->coalesced_timer, next_clock);
 123     }
 124 }
 125
 126 static void rtc_coalesced_timer(void *opaque)
 127 {
 128     RTCState *s = opaque;
 129
 130     if (s->irq_coalesced != 0) {
 131         apic_reset_irq_delivered();
 132         s->cmos_data[RTC_REG_C] |= 0xc0;
 133         DPRINTF_C("cmos: injecting from timer\n");
 134         qemu_irq_raise(s->irq);
 135         if (apic_get_irq_delivered()) {
 136             s->irq_coalesced--;
 137             DPRINTF_C("cmos: coalesced irqs decreased to %d\n",
 138                       s->irq_coalesced);
 139         }
 140     }
 141
 142     rtc_coalesced_timer_update(s);
 143 }
 144 #endif
 145
 146 /* handle periodic timer */
 147 static void periodic_timer_update(RTCState *s, int64_t current_time)
 148 {
 149     int period_code, period;
 150     int64_t cur_clock, next_irq_clock;
 151
 152     period_code = s->cmos_data[RTC_REG_A] & 0x0f;
 153     if (period_code != 0
 154         && (s->cmos_data[RTC_REG_B] & REG_B_PIE)) {
 155         if (period_code <= 2)
 156             period_code += 7;
 157         /* period in 32 Khz cycles */
 158         period = 1 << (period_code - 1);
 159 #ifdef TARGET_I386
 160         if (period != s->period) {
 161             s->irq_coalesced = (s->irq_coalesced * s->period) / period;
 162             DPRINTF_C("cmos: coalesced irqs scaled to %d\n", s->irq_coalesced);
 163         }
 164         s->period = period;
 165 #endif
 166         /* compute 32 khz clock */
 167         cur_clock = muldiv64(current_time, RTC_CLOCK_RATE, get_ticks_per_sec());
 168         next_irq_clock = (cur_clock & ~(period - 1)) + period;
 169         s->next_periodic_time =
 170             muldiv64(next_irq_clock, get_ticks_per_sec(), RTC_CLOCK_RATE) + 1;
 171         timer_mod(s->periodic_timer, s->next_periodic_time);
 172     } else {
 173 #ifdef TARGET_I386
 174         s->irq_coalesced = 0;
 175 #endif
 176         timer_del(s->periodic_timer);
 177     }
 178 }
 179
 180 static void rtc_periodic_timer(void *opaque)
 181 {
 182     RTCState *s = opaque;
 183
 184     periodic_timer_update(s, s->next_periodic_time);
 185     s->cmos_data[RTC_REG_C] |= REG_C_PF;
 186     if (s->cmos_data[RTC_REG_B] & REG_B_PIE) {
 187         s->cmos_data[RTC_REG_C] |= REG_C_IRQF;
 188 #ifdef TARGET_I386
 189         if (s->lost_tick_policy == LOST_TICK_POLICY_SLEW) {
 190             if (s->irq_reinject_on_ack_count >= RTC_REINJECT_ON_ACK_COUNT)
 191                 s->irq_reinject_on_ack_count = 0;
 192             apic_reset_irq_delivered();
 193             qemu_irq_raise(s->irq);
 194             if (!apic_get_irq_delivered()) {
 195                 s->irq_coalesced++;
 196                 rtc_coalesced_timer_update(s);
 197                 DPRINTF_C("cmos: coalesced irqs increased to %d\n",
 198                           s->irq_coalesced);
 199             }
 200         } else
 201 #endif
 202         qemu_irq_raise(s->irq);
 203     }
 204 }
 205
 206 /* handle update-ended timer */
 207 static void check_update_timer(RTCState *s)
 208 {
 209     uint64_t next_update_time;
 210     uint64_t guest_nsec;
 211     int next_alarm_sec;
 212
 213     /* From the data sheet: "Holding the dividers in reset prevents
 214      * interrupts from operating, while setting the SET bit allows"
 215      * them to occur.  However, it will prevent an alarm interrupt
 216      * from occurring, because the time of day is not updated.
 217      */
 218     if ((s->cmos_data[RTC_REG_A] & 0x60) == 0x60) {
 219         timer_del(s->update_timer);
 220         return;
 221     }
 222     if ((s->cmos_data[RTC_REG_C] & REG_C_UF) &&
 223         (s->cmos_data[RTC_REG_B] & REG_B_SET)) {
 224         timer_del(s->update_timer);
 225         return;
 226     }
 227     if ((s->cmos_data[RTC_REG_C] & REG_C_UF) &&
 228         (s->cmos_data[RTC_REG_C] & REG_C_AF)) {
 229         timer_del(s->update_timer);
 230         return;
 231     }
 232
 233     guest_nsec = get_guest_rtc_ns(s) % NSEC_PER_SEC;
 234     /* if UF is clear, reprogram to next second */
 235     next_update_time = qemu_clock_get_ns(rtc_clock)
 236         + NSEC_PER_SEC - guest_nsec;
 237
 238     /* Compute time of next alarm.  One second is already accounted
 239      * for in next_update_time.
 240      */
 241     next_alarm_sec = get_next_alarm(s);
 242     s->next_alarm_time = next_update_time + (next_alarm_sec - 1) * NSEC_PER_SEC;
 243
 244     if (s->cmos_data[RTC_REG_C] & REG_C_UF) {
 245         /* UF is set, but AF is clear.  Program the timer to target
 246          * the alarm time.  */
 247         next_update_time = s->next_alarm_time;
 248     }
 249     if (next_update_time != timer_expire_time_ns(s->update_timer)) {
 250         timer_mod(s->update_timer, next_update_time);
 251     }
 252 }
 253
 254 static inline uint8_t convert_hour(RTCState *s, uint8_t hour)
 255 {
 256     if (!(s->cmos_data[RTC_REG_B] & REG_B_24H)) {
 257         hour %= 12;
 258         if (s->cmos_data[RTC_HOURS] & 0x80) {
 259             hour += 12;
 260         }
 261     }
 262     return hour;
 263 }
 264
 265 static uint64_t get_next_alarm(RTCState *s)
 266 {
 267     int32_t alarm_sec, alarm_min, alarm_hour, cur_hour, cur_min, cur_sec;
 268     int32_t hour, min, sec;
 269
 270     rtc_update_time(s);
 271
 272     alarm_sec = rtc_from_bcd(s, s->cmos_data[RTC_SECONDS_ALARM]);
 273     alarm_min = rtc_from_bcd(s, s->cmos_data[RTC_MINUTES_ALARM]);
 274     alarm_hour = rtc_from_bcd(s, s->cmos_data[RTC_HOURS_ALARM]);
 275     alarm_hour = alarm_hour == -1 ? -1 : convert_hour(s, alarm_hour);
 276
 277     cur_sec = rtc_from_bcd(s, s->cmos_data[RTC_SECONDS]);
 278     cur_min = rtc_from_bcd(s, s->cmos_data[RTC_MINUTES]);
 279     cur_hour = rtc_from_bcd(s, s->cmos_data[RTC_HOURS]);
 280     cur_hour = convert_hour(s, cur_hour);
 281
 282     if (alarm_hour == -1) {
 283         alarm_hour = cur_hour;
 284         if (alarm_min == -1) {
 285             alarm_min = cur_min;
 286             if (alarm_sec == -1) {
 287                 alarm_sec = cur_sec + 1;
 288             } else if (cur_sec > alarm_sec) {
 289                 alarm_min++;
 290             }
 291         } else if (cur_min == alarm_min) {
 292             if (alarm_sec == -1) {
 293                 alarm_sec = cur_sec + 1;
 294             } else {
 295                 if (cur_sec > alarm_sec) {
 296                     alarm_hour++;
 297                 }
 298             }
 299             if (alarm_sec == SEC_PER_MIN) {
 300                 /* wrap to next hour, minutes is not in don't care mode */
 301                 alarm_sec = 0;
 302                 alarm_hour++;
 303             }
 304         } else if (cur_min > alarm_min) {
 305             alarm_hour++;
 306         }
 307     } else if (cur_hour == alarm_hour) {
 308         if (alarm_min == -1) {
 309             alarm_min = cur_min;
 310             if (alarm_sec == -1) {
 311                 alarm_sec = cur_sec + 1;
 312             } else if (cur_sec > alarm_sec) {
 313                 alarm_min++;
 314             }
 315
 316             if (alarm_sec == SEC_PER_MIN) {
 317                 alarm_sec = 0;
 318                 alarm_min++;
 319             }
 320             /* wrap to next day, hour is not in don't care mode */
 321             alarm_min %= MIN_PER_HOUR;
 322         } else if (cur_min == alarm_min) {
 323             if (alarm_sec == -1) {
 324                 alarm_sec = cur_sec + 1;
 325             }
 326             /* wrap to next day, hours+minutes not in don't care mode */
 327             alarm_sec %= SEC_PER_MIN;
 328         }
 329     }
 330
 331     /* values that are still don't care fire at the next min/sec */
 332     if (alarm_min == -1) {
 333         alarm_min = 0;
 334     }
 335     if (alarm_sec == -1) {
 336         alarm_sec = 0;
 337     }
 338
 339     /* keep values in range */
 340     if (alarm_sec == SEC_PER_MIN) {
 341         alarm_sec = 0;
 342         alarm_min++;
 343     }
 344     if (alarm_min == MIN_PER_HOUR) {
 345         alarm_min = 0;
 346         alarm_hour++;
 347     }
 348     alarm_hour %= HOUR_PER_DAY;
 349
 350     hour = alarm_hour - cur_hour;
 351     min = hour * MIN_PER_HOUR + alarm_min - cur_min;
 352     sec = min * SEC_PER_MIN + alarm_sec - cur_sec;
 353     return sec <= 0 ? sec + SEC_PER_DAY : sec;
 354 }
 355
 356 static void rtc_update_timer(void *opaque)
 357 {
 358     RTCState *s = opaque;
 359     int32_t irqs = REG_C_UF;
 360     int32_t new_irqs;
 361
 362     assert((s->cmos_data[RTC_REG_A] & 0x60) != 0x60);
 363
 364     /* UIP might have been latched, update time and clear it.  */
 365     rtc_update_time(s);
 366     s->cmos_data[RTC_REG_A] &= ~REG_A_UIP;
 367
 368     if (qemu_clock_get_ns(rtc_clock) >= s->next_alarm_time) {
 369         irqs |= REG_C_AF;
 370         if (s->cmos_data[RTC_REG_B] & REG_B_AIE) {
 371             qemu_system_wakeup_request(QEMU_WAKEUP_REASON_RTC);
 372         }
 373     }
 374
 375     new_irqs = irqs & ~s->cmos_data[RTC_REG_C];
 376     s->cmos_data[RTC_REG_C] |= irqs;
 377     if ((new_irqs & s->cmos_data[RTC_REG_B]) != 0) {
 378         s->cmos_data[RTC_REG_C] |= REG_C_IRQF;
 379         qemu_irq_raise(s->irq);
 380     }
 381     check_update_timer(s);
 382 }
 383
 384 static void cmos_ioport_write(void *opaque, hwaddr addr,
 385                               uint64_t data, unsigned size)
 386 {
 387     RTCState *s = opaque;
 388
 389     if ((addr & 1) == 0) {
 390         s->cmos_index = data & 0x7f;
 391     } else {
 392         CMOS_DPRINTF("cmos: write index=0x%02x val=0x%02x\n",
 393                      s->cmos_index, data);
 394         switch(s->cmos_index) {
 395         case RTC_SECONDS_ALARM:
 396         case RTC_MINUTES_ALARM:
 397         case RTC_HOURS_ALARM:
 398             s->cmos_data[s->cmos_index] = data;
 399             check_update_timer(s);
 400             break;
 401         case RTC_IBM_PS2_CENTURY_BYTE:
 402             s->cmos_index = RTC_CENTURY;
 403             /* fall through */
 404         case RTC_CENTURY:
 405         case RTC_SECONDS:
 406         case RTC_MINUTES:
 407         case RTC_HOURS:
 408         case RTC_DAY_OF_WEEK:
 409         case RTC_DAY_OF_MONTH:
 410         case RTC_MONTH:
 411         case RTC_YEAR:
 412             s->cmos_data[s->cmos_index] = data;
 413             /* if in set mode, do not update the time */
 414             if (rtc_running(s)) {
 415                 rtc_set_time(s);
 416                 check_update_timer(s);
 417             }
 418             break;
 419         case RTC_REG_A:
 420             if ((data & 0x60) == 0x60) {
 421                 if (rtc_running(s)) {
 422                     rtc_update_time(s);
 423                 }
 424                 /* What happens to UIP when divider reset is enabled is
 425                  * unclear from the datasheet.  Shouldn't matter much
 426                  * though.
 427                  */
 428                 s->cmos_data[RTC_REG_A] &= ~REG_A_UIP;
 429             } else if (((s->cmos_data[RTC_REG_A] & 0x60) == 0x60) &&
 430                     (data & 0x70)  <= 0x20) {
 431                 /* when the divider reset is removed, the first update cycle
 432                  * begins one-half second later*/
 433                 if (!(s->cmos_data[RTC_REG_B] & REG_B_SET)) {
 434                     s->offset = 500000000;
 435                     rtc_set_time(s);
 436                 }
 437                 s->cmos_data[RTC_REG_A] &= ~REG_A_UIP;
 438             }
 439             /* UIP bit is read only */
 440             s->cmos_data[RTC_REG_A] = (data & ~REG_A_UIP) |
 441                 (s->cmos_data[RTC_REG_A] & REG_A_UIP);
 442             periodic_timer_update(s, qemu_clock_get_ns(rtc_clock));
 443             check_update_timer(s);
 444             break;
 445         case RTC_REG_B:
 446             if (data & REG_B_SET) {
 447                 /* update cmos to when the rtc was stopping */
 448                 if (rtc_running(s)) {
 449                     rtc_update_time(s);
 450                 }
 451                 /* set mode: reset UIP mode */
 452                 s->cmos_data[RTC_REG_A] &= ~REG_A_UIP;
 453                 data &= ~REG_B_UIE;
 454             } else {
 455                 /* if disabling set mode, update the time */
 456                 if ((s->cmos_data[RTC_REG_B] & REG_B_SET) &&
 457                     (s->cmos_data[RTC_REG_A] & 0x70) <= 0x20) {
 458                     s->offset = get_guest_rtc_ns(s) % NSEC_PER_SEC;
 459                     rtc_set_time(s);
 460                 }
 461             }
 462             /* if an interrupt flag is already set when the interrupt
 463              * becomes enabled, raise an interrupt immediately.  */
 464             if (data & s->cmos_data[RTC_REG_C] & REG_C_MASK) {
 465                 s->cmos_data[RTC_REG_C] |= REG_C_IRQF;
 466                 qemu_irq_raise(s->irq);
 467             } else {
 468                 s->cmos_data[RTC_REG_C] &= ~REG_C_IRQF;
 469                 qemu_irq_lower(s->irq);
 470             }
 471             s->cmos_data[RTC_REG_B] = data;
 472             periodic_timer_update(s, qemu_clock_get_ns(rtc_clock));
 473             check_update_timer(s);
 474             break;
 475         case RTC_REG_C:
 476         case RTC_REG_D:
 477             /* cannot write to them */
 478             break;
 479         default:
 480             s->cmos_data[s->cmos_index] = data;
 481             break;
 482         }
 483     }
 484 }
 485
 486 static inline int rtc_to_bcd(RTCState *s, int a)
 487 {
 488     if (s->cmos_data[RTC_REG_B] & REG_B_DM) {
 489         return a;
 490     } else {
 491         return ((a / 10) << 4) | (a % 10);
 492     }
 493 }
 494
 495 static inline int rtc_from_bcd(RTCState *s, int a)
 496 {
 497     if ((a & 0xc0) == 0xc0) {
 498         return -1;
 499     }
 500     if (s->cmos_data[RTC_REG_B] & REG_B_DM) {
 501         return a;
 502     } else {
 503         return ((a >> 4) * 10) + (a & 0x0f);
 504     }
 505 }
 506
 507 static void rtc_get_time(RTCState *s, struct tm *tm)
 508 {
 509     tm->tm_sec = rtc_from_bcd(s, s->cmos_data[RTC_SECONDS]);
 510     tm->tm_min = rtc_from_bcd(s, s->cmos_data[RTC_MINUTES]);
 511     tm->tm_hour = rtc_from_bcd(s, s->cmos_data[RTC_HOURS] & 0x7f);
 512     if (!(s->cmos_data[RTC_REG_B] & REG_B_24H)) {
 513         tm->tm_hour %= 12;
 514         if (s->cmos_data[RTC_HOURS] & 0x80) {
 515             tm->tm_hour += 12;
 516         }
 517     }
 518     tm->tm_wday = rtc_from_bcd(s, s->cmos_data[RTC_DAY_OF_WEEK]) - 1;
 519     tm->tm_mday = rtc_from_bcd(s, s->cmos_data[RTC_DAY_OF_MONTH]);
 520     tm->tm_mon = rtc_from_bcd(s, s->cmos_data[RTC_MONTH]) - 1;
 521     tm->tm_year =
 522         rtc_from_bcd(s, s->cmos_data[RTC_YEAR]) + s->base_year +
 523         rtc_from_bcd(s, s->cmos_data[RTC_CENTURY]) * 100 - 1900;
 524 }
 525
 526 static void rtc_set_time(RTCState *s)
 527 {
 528     struct tm tm;
 529
 530     rtc_get_time(s, &tm);
 531     s->base_rtc = mktimegm(&tm);
 532     s->last_update = qemu_clock_get_ns(rtc_clock);
 533
 534     qapi_event_send_rtc_change(qemu_timedate_diff(&tm), &error_abort);
 535 }
 536
 537 static void rtc_set_cmos(RTCState *s, const struct tm *tm)
 538 {
 539     int year;
 540
 541     s->cmos_data[RTC_SECONDS] = rtc_to_bcd(s, tm->tm_sec);
 542     s->cmos_data[RTC_MINUTES] = rtc_to_bcd(s, tm->tm_min);
 543     if (s->cmos_data[RTC_REG_B] & REG_B_24H) {
 544         /* 24 hour format */
 545         s->cmos_data[RTC_HOURS] = rtc_to_bcd(s, tm->tm_hour);
 546     } else {
 547         /* 12 hour format */
 548         int h = (tm->tm_hour % 12) ? tm->tm_hour % 12 : 12;
 549         s->cmos_data[RTC_HOURS] = rtc_to_bcd(s, h);
 550         if (tm->tm_hour >= 12)
 551             s->cmos_data[RTC_HOURS] |= 0x80;
 552     }
 553     s->cmos_data[RTC_DAY_OF_WEEK] = rtc_to_bcd(s, tm->tm_wday + 1);
 554     s->cmos_data[RTC_DAY_OF_MONTH] = rtc_to_bcd(s, tm->tm_mday);
 555     s->cmos_data[RTC_MONTH] = rtc_to_bcd(s, tm->tm_mon + 1);
 556     year = tm->tm_year + 1900 - s->base_year;
 557     s->cmos_data[RTC_YEAR] = rtc_to_bcd(s, year % 100);
 558     s->cmos_data[RTC_CENTURY] = rtc_to_bcd(s, year / 100);
 559 }
 560
 561 static void rtc_update_time(RTCState *s)
 562 {
 563     struct tm ret;
 564     time_t guest_sec;
 565     int64_t guest_nsec;
 566
 567     guest_nsec = get_guest_rtc_ns(s);
 568     guest_sec = guest_nsec / NSEC_PER_SEC;
 569     gmtime_r(&guest_sec, &ret);
 570
 571     /* Is SET flag of Register B disabled? */
 572     if ((s->cmos_data[RTC_REG_B] & REG_B_SET) == 0) {
 573         rtc_set_cmos(s, &ret);
 574     }
 575 }
 576
 577 static int update_in_progress(RTCState *s)
 578 {
 579     int64_t guest_nsec;
 580
 581     if (!rtc_running(s)) {
 582         return 0;
 583     }
 584     if (timer_pending(s->update_timer)) {
 585         int64_t next_update_time = timer_expire_time_ns(s->update_timer);
 586         /* Latch UIP until the timer expires.  */
 587         if (qemu_clock_get_ns(rtc_clock) >=
 588             (next_update_time - UIP_HOLD_LENGTH)) {
 589             s->cmos_data[RTC_REG_A] |= REG_A_UIP;
 590             return 1;
 591         }
 592     }
 593
 594     guest_nsec = get_guest_rtc_ns(s);
 595     /* UIP bit will be set at last 244us of every second. */
 596     if ((guest_nsec % NSEC_PER_SEC) >= (NSEC_PER_SEC - UIP_HOLD_LENGTH)) {
 597         return 1;
 598     }
 599     return 0;
 600 }
 601
 602 static uint64_t cmos_ioport_read(void *opaque, hwaddr addr,
 603                                  unsigned size)
 604 {
 605     RTCState *s = opaque;
 606     int ret;
 607     if ((addr & 1) == 0) {
 608         return 0xff;
 609     } else {
 610         switch(s->cmos_index) {
 611         case RTC_IBM_PS2_CENTURY_BYTE:
 612             s->cmos_index = RTC_CENTURY;
 613             /* fall through */
 614         case RTC_CENTURY:
 615         case RTC_SECONDS:
 616         case RTC_MINUTES:
 617         case RTC_HOURS:
 618         case RTC_DAY_OF_WEEK:
 619         case RTC_DAY_OF_MONTH:
 620         case RTC_MONTH:
 621         case RTC_YEAR:
 622             /* if not in set mode, calibrate cmos before
 623              * reading*/
 624             if (rtc_running(s)) {
 625                 rtc_update_time(s);
 626             }
 627             ret = s->cmos_data[s->cmos_index];
 628             break;
 629         case RTC_REG_A:
 630             if (update_in_progress(s)) {
 631                 s->cmos_data[s->cmos_index] |= REG_A_UIP;
 632             } else {
 633                 s->cmos_data[s->cmos_index] &= ~REG_A_UIP;
 634             }
 635             ret = s->cmos_data[s->cmos_index];
 636             break;
 637         case RTC_REG_C:
 638             ret = s->cmos_data[s->cmos_index];
 639             qemu_irq_lower(s->irq);
 640             s->cmos_data[RTC_REG_C] = 0x00;
 641             if (ret & (REG_C_UF | REG_C_AF)) {
 642                 check_update_timer(s);
 643             }
 644 #ifdef TARGET_I386
 645             if(s->irq_coalesced &&
 646                     (s->cmos_data[RTC_REG_B] & REG_B_PIE) &&
 647                     s->irq_reinject_on_ack_count < RTC_REINJECT_ON_ACK_COUNT) {
 648                 s->irq_reinject_on_ack_count++;
 649                 s->cmos_data[RTC_REG_C] |= REG_C_IRQF | REG_C_PF;
 650                 apic_reset_irq_delivered();
 651                 DPRINTF_C("cmos: injecting on ack\n");
 652                 qemu_irq_raise(s->irq);
 653                 if (apic_get_irq_delivered()) {
 654                     s->irq_coalesced--;
 655                     DPRINTF_C("cmos: coalesced irqs decreased to %d\n",
 656                               s->irq_coalesced);
 657                 }
 658             }
 659 #endif
 660             break;
 661         default:
 662             ret = s->cmos_data[s->cmos_index];
 663             break;
 664         }
 665         CMOS_DPRINTF("cmos: read index=0x%02x val=0x%02x\n",
 666                      s->cmos_index, ret);
 667         return ret;
 668     }
 669 }
 670
 671 void rtc_set_memory(ISADevice *dev, int addr, int val)
 672 {
 673     RTCState *s = MC146818_RTC(dev);
 674     if (addr >= 0 && addr <= 127)
 675         s->cmos_data[addr] = val;
 676 }
 677
 678 int rtc_get_memory(ISADevice *dev, int addr)
 679 {
 680     RTCState *s = MC146818_RTC(dev);
 681     assert(addr >= 0 && addr <= 127);
 682     return s->cmos_data[addr];
 683 }
 684
 685 static void rtc_set_date_from_host(ISADevice *dev)
 686 {
 687     RTCState *s = MC146818_RTC(dev);
 688     struct tm tm;
 689
 690     qemu_get_timedate(&tm, 0);
 691
 692     s->base_rtc = mktimegm(&tm);
 693     s->last_update = qemu_clock_get_ns(rtc_clock);
 694     s->offset = 0;
 695
 696     /* set the CMOS date */
 697     rtc_set_cmos(s, &tm);
 698 }
 699
 700 static int rtc_post_load(void *opaque, int version_id)
 701 {
 702     RTCState *s = opaque;
 703
 704     if (version_id <= 2) {
 705         rtc_set_time(s);
 706         s->offset = 0;
 707         check_update_timer(s);
 708     }
 709
 710 #ifdef TARGET_I386
 711     if (version_id >= 2) {
 712         if (s->lost_tick_policy == LOST_TICK_POLICY_SLEW) {
 713             rtc_coalesced_timer_update(s);
 714         }
 715     }
 716 #endif
 717     return 0;
 718 }
 719
 720 static const VMStateDescription vmstate_rtc = {
 721     .name = "mc146818rtc",
 722     .version_id = 3,
 723     .minimum_version_id = 1,
 724     .post_load = rtc_post_load,
 725     .fields = (VMStateField[]) {
 726         VMSTATE_BUFFER(cmos_data, RTCState),
 727         VMSTATE_UINT8(cmos_index, RTCState),
 728         VMSTATE_UNUSED(7*4),
 729         VMSTATE_TIMER(periodic_timer, RTCState),
 730         VMSTATE_INT64(next_periodic_time, RTCState),
 731         VMSTATE_UNUSED(3*8),
 732         VMSTATE_UINT32_V(irq_coalesced, RTCState, 2),
 733         VMSTATE_UINT32_V(period, RTCState, 2),
 734         VMSTATE_UINT64_V(base_rtc, RTCState, 3),
 735         VMSTATE_UINT64_V(last_update, RTCState, 3),
 736         VMSTATE_INT64_V(offset, RTCState, 3),
 737         VMSTATE_TIMER_V(update_timer, RTCState, 3),
 738         VMSTATE_UINT64_V(next_alarm_time, RTCState, 3),
 739         VMSTATE_END_OF_LIST()
 740     }
 741 };
 742
 743 static void rtc_notify_clock_reset(Notifier *notifier, void *data)
 744 {
 745     RTCState *s = container_of(notifier, RTCState, clock_reset_notifier);
 746     int64_t now = *(int64_t *)data;
 747
 748     rtc_set_date_from_host(ISA_DEVICE(s));
 749     periodic_timer_update(s, now);
 750     check_update_timer(s);
 751 #ifdef TARGET_I386
 752     if (s->lost_tick_policy == LOST_TICK_POLICY_SLEW) {
 753         rtc_coalesced_timer_update(s);
 754     }
 755 #endif
 756 }
 757
 758 /* set CMOS shutdown status register (index 0xF) as S3_resume(0xFE)
 759    BIOS will read it and start S3 resume at POST Entry */
 760 static void rtc_notify_suspend(Notifier *notifier, void *data)
 761 {
 762     RTCState *s = container_of(notifier, RTCState, suspend_notifier);
 763     rtc_set_memory(ISA_DEVICE(s), 0xF, 0xFE);
 764 }
 765
 766 static void rtc_reset(void *opaque)
 767 {
 768     RTCState *s = opaque;
 769
 770     s->cmos_data[RTC_REG_B] &= ~(REG_B_PIE | REG_B_AIE | REG_B_SQWE);
 771     s->cmos_data[RTC_REG_C] &= ~(REG_C_UF | REG_C_IRQF | REG_C_PF | REG_C_AF);
 772     check_update_timer(s);
 773
 774     qemu_irq_lower(s->irq);
 775
 776 #ifdef TARGET_I386
 777     if (s->lost_tick_policy == LOST_TICK_POLICY_SLEW) {
 778         s->irq_coalesced = 0;
 779     }
 780 #endif
 781 }
 782
 783 static const MemoryRegionOps cmos_ops = {
 784     .read = cmos_ioport_read,
 785     .write = cmos_ioport_write,
 786     .impl = {
 787         .min_access_size = 1,
 788         .max_access_size = 1,
 789     },
 790     .endianness = DEVICE_LITTLE_ENDIAN,
 791 };
 792
 793 static void rtc_get_date(Object *obj, Visitor *v, void *opaque,
 794                          const char *name, Error **errp)
 795 {
 796     Error *err = NULL;
 797     RTCState *s = MC146818_RTC(obj);
 798     struct tm current_tm;
 799
 800     rtc_update_time(s);
 801     rtc_get_time(s, &current_tm);
 802     visit_start_struct(v, NULL, "struct tm", name, 0, &err);
 803     if (err) {
 804         goto out;
 805     }
 806     visit_type_int32(v, &current_tm.tm_year, "tm_year", &err);
 807     if (err) {
 808         goto out_end;
 809     }
 810     visit_type_int32(v, &current_tm.tm_mon, "tm_mon", &err);
 811     if (err) {
 812         goto out_end;
 813     }
 814     visit_type_int32(v, &current_tm.tm_mday, "tm_mday", &err);
 815     if (err) {
 816         goto out_end;
 817     }
 818     visit_type_int32(v, &current_tm.tm_hour, "tm_hour", &err);
 819     if (err) {
 820         goto out_end;
 821     }
 822     visit_type_int32(v, &current_tm.tm_min, "tm_min", &err);
 823     if (err) {
 824         goto out_end;
 825     }
 826     visit_type_int32(v, &current_tm.tm_sec, "tm_sec", &err);
 827     if (err) {
 828         goto out_end;
 829     }
 830 out_end:
 831     error_propagate(errp, err);
 832     err = NULL;
 833     visit_end_struct(v, errp);
 834 out:
 835     error_propagate(errp, err);
 836 }
 837
 838 static void rtc_realizefn(DeviceState *dev, Error **errp)
 839 {
 840     ISADevice *isadev = ISA_DEVICE(dev);
 841     RTCState *s = MC146818_RTC(dev);
 842     int base = 0x70;
 843
 844     s->cmos_data[RTC_REG_A] = 0x26;
 845     s->cmos_data[RTC_REG_B] = 0x02;
 846     s->cmos_data[RTC_REG_C] = 0x00;
 847     s->cmos_data[RTC_REG_D] = 0x80;
 848
 849     /* This is for historical reasons.  The default base year qdev property
 850      * was set to 2000 for most machine types before the century byte was
 851      * implemented.
 852      *
 853      * This if statement means that the century byte will be always 0
 854      * (at least until 2079...) for base_year = 1980, but will be set
 855      * correctly for base_year = 2000.
 856      */
 857     if (s->base_year == 2000) {
 858         s->base_year = 0;
 859     }
 860
 861     rtc_set_date_from_host(isadev);
 862
 863 #ifdef TARGET_I386
 864     switch (s->lost_tick_policy) {
 865     case LOST_TICK_POLICY_SLEW:
 866         s->coalesced_timer =
 867             timer_new_ns(rtc_clock, rtc_coalesced_timer, s);
 868         break;
 869     case LOST_TICK_POLICY_DISCARD:
 870         break;
 871     default:
 872         error_setg(errp, "Invalid lost tick policy.");
 873         return;
 874     }
 875 #endif
 876
 877     s->periodic_timer = timer_new_ns(rtc_clock, rtc_periodic_timer, s);
 878     s->update_timer = timer_new_ns(rtc_clock, rtc_update_timer, s);
 879     check_update_timer(s);
 880
 881     s->clock_reset_notifier.notify = rtc_notify_clock_reset;
 882     qemu_clock_register_reset_notifier(QEMU_CLOCK_REALTIME,
 883                                        &s->clock_reset_notifier);
 884
 885     s->suspend_notifier.notify = rtc_notify_suspend;
 886     qemu_register_suspend_notifier(&s->suspend_notifier);
 887
 888     memory_region_init_io(&s->io, OBJECT(s), &cmos_ops, s, "rtc", 2);
 889     isa_register_ioport(isadev, &s->io, base);
 890
 891     qdev_set_legacy_instance_id(dev, base, 3);
 892     qemu_register_reset(rtc_reset, s);
 893
 894     object_property_add(OBJECT(s), "date", "struct tm",
 895                         rtc_get_date, NULL, NULL, s, NULL);
 896 }
 897
 898 ISADevice *rtc_init(ISABus *bus, int base_year, qemu_irq intercept_irq)
 899 {
 900     DeviceState *dev;
 901     ISADevice *isadev;
 902     RTCState *s;
 903
 904     isadev = isa_create(bus, TYPE_MC146818_RTC);
 905     dev = DEVICE(isadev);
 906     s = MC146818_RTC(isadev);
 907     qdev_prop_set_int32(dev, "base_year", base_year);
 908     qdev_init_nofail(dev);
 909     if (intercept_irq) {
 910         s->irq = intercept_irq;
 911     } else {
 912         isa_init_irq(isadev, &s->irq, RTC_ISA_IRQ);
 913     }
 914     return isadev;
 915 }
 916
 917 static Property mc146818rtc_properties[] = {
 918     DEFINE_PROP_INT32("base_year", RTCState, base_year, 1980),
 919     DEFINE_PROP_LOSTTICKPOLICY("lost_tick_policy", RTCState,
 920                                lost_tick_policy, LOST_TICK_POLICY_DISCARD),
 921     DEFINE_PROP_END_OF_LIST(),
 922 };
 923
 924 static void rtc_class_initfn(ObjectClass *klass, void *data)
 925 {
 926     DeviceClass *dc = DEVICE_CLASS(klass);
 927
 928     dc->realize = rtc_realizefn;
 929     dc->vmsd = &vmstate_rtc;
 930     dc->props = mc146818rtc_properties;
 931     /* Reason: needs to be wired up by rtc_init() */
 932     dc->cannot_instantiate_with_device_add_yet = true;
 933 }
 934
 935 static const TypeInfo mc146818rtc_info = {
 936     .name          = TYPE_MC146818_RTC,
 937     .parent        = TYPE_ISA_DEVICE,
 938     .instance_size = sizeof(RTCState),
 939     .class_init    = rtc_class_initfn,
 940 };
 941
 942 static void mc146818rtc_register_types(void)
 943 {
 944     type_register_static(&mc146818rtc_info);
 945 }
 946
 947 type_init(mc146818rtc_register_types)