2 * QEMU MC146818 RTC emulation
4 * Copyright (c) 2003-2004 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu-timer.h"
29 #include "hpet_emul.h"
34 #define RTC_SECONDS_ALARM 1
36 #define RTC_MINUTES_ALARM 3
38 #define RTC_HOURS_ALARM 5
39 #define RTC_ALARM_DONT_CARE 0xC0
41 #define RTC_DAY_OF_WEEK 6
42 #define RTC_DAY_OF_MONTH 7
51 #define REG_A_UIP 0x80
53 #define REG_B_SET 0x80
54 #define REG_B_PIE 0x40
55 #define REG_B_AIE 0x20
56 #define REG_B_UIE 0x10
57 #define REG_B_SQWE 0x08
61 #define REG_C_IRQF 0x80
67 uint8_t cmos_data
[128];
75 QEMUTimer
*periodic_timer
;
76 int64_t next_periodic_time
;
78 int64_t next_second_time
;
79 uint32_t irq_coalesced
;
81 QEMUTimer
*coalesced_timer
;
82 QEMUTimer
*second_timer
;
83 QEMUTimer
*second_timer2
;
86 static void rtc_irq_raise(qemu_irq irq
)
88 /* When HPET is operating in legacy mode, RTC interrupts are disabled
89 * We block qemu_irq_raise, but not qemu_irq_lower, in case legacy
90 * mode is established while interrupt is raised. We want it to
91 * be lowered in any case
93 #if defined TARGET_I386
94 if (!hpet_in_legacy_mode())
99 static void rtc_set_time(RTCState
*s
);
100 static void rtc_copy_date(RTCState
*s
);
103 static void rtc_coalesced_timer_update(RTCState
*s
)
105 if (s
->irq_coalesced
== 0) {
106 qemu_del_timer(s
->coalesced_timer
);
108 /* divide each RTC interval to 2 - 8 smaller intervals */
109 int c
= MIN(s
->irq_coalesced
, 7) + 1;
110 int64_t next_clock
= qemu_get_clock(rtc_clock
) +
111 muldiv64(s
->period
/ c
, get_ticks_per_sec(), 32768);
112 qemu_mod_timer(s
->coalesced_timer
, next_clock
);
116 static void rtc_coalesced_timer(void *opaque
)
118 RTCState
*s
= opaque
;
120 if (s
->irq_coalesced
!= 0) {
121 apic_reset_irq_delivered();
122 s
->cmos_data
[RTC_REG_C
] |= 0xc0;
123 rtc_irq_raise(s
->irq
);
124 if (apic_get_irq_delivered()) {
129 rtc_coalesced_timer_update(s
);
133 static void rtc_timer_update(RTCState
*s
, int64_t current_time
)
135 int period_code
, period
;
136 int64_t cur_clock
, next_irq_clock
;
139 period_code
= s
->cmos_data
[RTC_REG_A
] & 0x0f;
140 #if defined TARGET_I386
141 /* disable periodic timer if hpet is in legacy mode, since interrupts are
144 enable_pie
= !hpet_in_legacy_mode();
149 && (((s
->cmos_data
[RTC_REG_B
] & REG_B_PIE
) && enable_pie
)
150 || ((s
->cmos_data
[RTC_REG_B
] & REG_B_SQWE
) && s
->sqw_irq
))) {
151 if (period_code
<= 2)
153 /* period in 32 Khz cycles */
154 period
= 1 << (period_code
- 1);
156 if(period
!= s
->period
)
157 s
->irq_coalesced
= (s
->irq_coalesced
* s
->period
) / period
;
160 /* compute 32 khz clock */
161 cur_clock
= muldiv64(current_time
, 32768, get_ticks_per_sec());
162 next_irq_clock
= (cur_clock
& ~(period
- 1)) + period
;
163 s
->next_periodic_time
=
164 muldiv64(next_irq_clock
, get_ticks_per_sec(), 32768) + 1;
165 qemu_mod_timer(s
->periodic_timer
, s
->next_periodic_time
);
168 s
->irq_coalesced
= 0;
170 qemu_del_timer(s
->periodic_timer
);
174 static void rtc_periodic_timer(void *opaque
)
176 RTCState
*s
= opaque
;
178 rtc_timer_update(s
, s
->next_periodic_time
);
179 if (s
->cmos_data
[RTC_REG_B
] & REG_B_PIE
) {
180 s
->cmos_data
[RTC_REG_C
] |= 0xc0;
183 apic_reset_irq_delivered();
184 rtc_irq_raise(s
->irq
);
185 if (!apic_get_irq_delivered()) {
187 rtc_coalesced_timer_update(s
);
191 rtc_irq_raise(s
->irq
);
193 if (s
->cmos_data
[RTC_REG_B
] & REG_B_SQWE
) {
194 /* Not square wave at all but we don't want 2048Hz interrupts!
195 Must be seen as a pulse. */
196 qemu_irq_raise(s
->sqw_irq
);
200 static void cmos_ioport_write(void *opaque
, uint32_t addr
, uint32_t data
)
202 RTCState
*s
= opaque
;
204 if ((addr
& 1) == 0) {
205 s
->cmos_index
= data
& 0x7f;
208 printf("cmos: write index=0x%02x val=0x%02x\n",
209 s
->cmos_index
, data
);
211 switch(s
->cmos_index
) {
212 case RTC_SECONDS_ALARM
:
213 case RTC_MINUTES_ALARM
:
214 case RTC_HOURS_ALARM
:
215 /* XXX: not supported */
216 s
->cmos_data
[s
->cmos_index
] = data
;
221 case RTC_DAY_OF_WEEK
:
222 case RTC_DAY_OF_MONTH
:
225 s
->cmos_data
[s
->cmos_index
] = data
;
226 /* if in set mode, do not update the time */
227 if (!(s
->cmos_data
[RTC_REG_B
] & REG_B_SET
)) {
232 /* UIP bit is read only */
233 s
->cmos_data
[RTC_REG_A
] = (data
& ~REG_A_UIP
) |
234 (s
->cmos_data
[RTC_REG_A
] & REG_A_UIP
);
235 rtc_timer_update(s
, qemu_get_clock(rtc_clock
));
238 if (data
& REG_B_SET
) {
239 /* set mode: reset UIP mode */
240 s
->cmos_data
[RTC_REG_A
] &= ~REG_A_UIP
;
243 /* if disabling set mode, update the time */
244 if (s
->cmos_data
[RTC_REG_B
] & REG_B_SET
) {
248 s
->cmos_data
[RTC_REG_B
] = data
;
249 rtc_timer_update(s
, qemu_get_clock(rtc_clock
));
253 /* cannot write to them */
256 s
->cmos_data
[s
->cmos_index
] = data
;
262 static inline int to_bcd(RTCState
*s
, int a
)
264 if (s
->cmos_data
[RTC_REG_B
] & REG_B_DM
) {
267 return ((a
/ 10) << 4) | (a
% 10);
271 static inline int from_bcd(RTCState
*s
, int a
)
273 if (s
->cmos_data
[RTC_REG_B
] & REG_B_DM
) {
276 return ((a
>> 4) * 10) + (a
& 0x0f);
280 static void rtc_set_time(RTCState
*s
)
282 struct tm
*tm
= &s
->current_tm
;
284 tm
->tm_sec
= from_bcd(s
, s
->cmos_data
[RTC_SECONDS
]);
285 tm
->tm_min
= from_bcd(s
, s
->cmos_data
[RTC_MINUTES
]);
286 tm
->tm_hour
= from_bcd(s
, s
->cmos_data
[RTC_HOURS
] & 0x7f);
287 if (!(s
->cmos_data
[RTC_REG_B
] & 0x02) &&
288 (s
->cmos_data
[RTC_HOURS
] & 0x80)) {
291 tm
->tm_wday
= from_bcd(s
, s
->cmos_data
[RTC_DAY_OF_WEEK
]) - 1;
292 tm
->tm_mday
= from_bcd(s
, s
->cmos_data
[RTC_DAY_OF_MONTH
]);
293 tm
->tm_mon
= from_bcd(s
, s
->cmos_data
[RTC_MONTH
]) - 1;
294 tm
->tm_year
= from_bcd(s
, s
->cmos_data
[RTC_YEAR
]) + s
->base_year
- 1900;
297 static void rtc_copy_date(RTCState
*s
)
299 const struct tm
*tm
= &s
->current_tm
;
302 s
->cmos_data
[RTC_SECONDS
] = to_bcd(s
, tm
->tm_sec
);
303 s
->cmos_data
[RTC_MINUTES
] = to_bcd(s
, tm
->tm_min
);
304 if (s
->cmos_data
[RTC_REG_B
] & 0x02) {
306 s
->cmos_data
[RTC_HOURS
] = to_bcd(s
, tm
->tm_hour
);
309 s
->cmos_data
[RTC_HOURS
] = to_bcd(s
, tm
->tm_hour
% 12);
310 if (tm
->tm_hour
>= 12)
311 s
->cmos_data
[RTC_HOURS
] |= 0x80;
313 s
->cmos_data
[RTC_DAY_OF_WEEK
] = to_bcd(s
, tm
->tm_wday
+ 1);
314 s
->cmos_data
[RTC_DAY_OF_MONTH
] = to_bcd(s
, tm
->tm_mday
);
315 s
->cmos_data
[RTC_MONTH
] = to_bcd(s
, tm
->tm_mon
+ 1);
316 year
= (tm
->tm_year
- s
->base_year
) % 100;
319 s
->cmos_data
[RTC_YEAR
] = to_bcd(s
, year
);
322 /* month is between 0 and 11. */
323 static int get_days_in_month(int month
, int year
)
325 static const int days_tab
[12] = {
326 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
329 if ((unsigned )month
>= 12)
333 if ((year
% 4) == 0 && ((year
% 100) != 0 || (year
% 400) == 0))
339 /* update 'tm' to the next second */
340 static void rtc_next_second(struct tm
*tm
)
345 if ((unsigned)tm
->tm_sec
>= 60) {
348 if ((unsigned)tm
->tm_min
>= 60) {
351 if ((unsigned)tm
->tm_hour
>= 24) {
355 if ((unsigned)tm
->tm_wday
>= 7)
357 days_in_month
= get_days_in_month(tm
->tm_mon
,
360 if (tm
->tm_mday
< 1) {
362 } else if (tm
->tm_mday
> days_in_month
) {
365 if (tm
->tm_mon
>= 12) {
376 static void rtc_update_second(void *opaque
)
378 RTCState
*s
= opaque
;
381 /* if the oscillator is not in normal operation, we do not update */
382 if ((s
->cmos_data
[RTC_REG_A
] & 0x70) != 0x20) {
383 s
->next_second_time
+= get_ticks_per_sec();
384 qemu_mod_timer(s
->second_timer
, s
->next_second_time
);
386 rtc_next_second(&s
->current_tm
);
388 if (!(s
->cmos_data
[RTC_REG_B
] & REG_B_SET
)) {
389 /* update in progress bit */
390 s
->cmos_data
[RTC_REG_A
] |= REG_A_UIP
;
392 /* should be 244 us = 8 / 32768 seconds, but currently the
393 timers do not have the necessary resolution. */
394 delay
= (get_ticks_per_sec() * 1) / 100;
397 qemu_mod_timer(s
->second_timer2
,
398 s
->next_second_time
+ delay
);
402 static void rtc_update_second2(void *opaque
)
404 RTCState
*s
= opaque
;
406 if (!(s
->cmos_data
[RTC_REG_B
] & REG_B_SET
)) {
411 if (s
->cmos_data
[RTC_REG_B
] & REG_B_AIE
) {
412 if (((s
->cmos_data
[RTC_SECONDS_ALARM
] & 0xc0) == 0xc0 ||
413 s
->cmos_data
[RTC_SECONDS_ALARM
] == s
->current_tm
.tm_sec
) &&
414 ((s
->cmos_data
[RTC_MINUTES_ALARM
] & 0xc0) == 0xc0 ||
415 s
->cmos_data
[RTC_MINUTES_ALARM
] == s
->current_tm
.tm_mon
) &&
416 ((s
->cmos_data
[RTC_HOURS_ALARM
] & 0xc0) == 0xc0 ||
417 s
->cmos_data
[RTC_HOURS_ALARM
] == s
->current_tm
.tm_hour
)) {
419 s
->cmos_data
[RTC_REG_C
] |= 0xa0;
420 rtc_irq_raise(s
->irq
);
424 /* update ended interrupt */
425 s
->cmos_data
[RTC_REG_C
] |= REG_C_UF
;
426 if (s
->cmos_data
[RTC_REG_B
] & REG_B_UIE
) {
427 s
->cmos_data
[RTC_REG_C
] |= REG_C_IRQF
;
428 rtc_irq_raise(s
->irq
);
431 /* clear update in progress bit */
432 s
->cmos_data
[RTC_REG_A
] &= ~REG_A_UIP
;
434 s
->next_second_time
+= get_ticks_per_sec();
435 qemu_mod_timer(s
->second_timer
, s
->next_second_time
);
438 static uint32_t cmos_ioport_read(void *opaque
, uint32_t addr
)
440 RTCState
*s
= opaque
;
442 if ((addr
& 1) == 0) {
445 switch(s
->cmos_index
) {
449 case RTC_DAY_OF_WEEK
:
450 case RTC_DAY_OF_MONTH
:
453 ret
= s
->cmos_data
[s
->cmos_index
];
456 ret
= s
->cmos_data
[s
->cmos_index
];
459 ret
= s
->cmos_data
[s
->cmos_index
];
460 qemu_irq_lower(s
->irq
);
461 s
->cmos_data
[RTC_REG_C
] = 0x00;
464 ret
= s
->cmos_data
[s
->cmos_index
];
468 printf("cmos: read index=0x%02x val=0x%02x\n",
475 void rtc_set_memory(RTCState
*s
, int addr
, int val
)
477 if (addr
>= 0 && addr
<= 127)
478 s
->cmos_data
[addr
] = val
;
481 void rtc_set_date(RTCState
*s
, const struct tm
*tm
)
487 /* PC cmos mappings */
488 #define REG_IBM_CENTURY_BYTE 0x32
489 #define REG_IBM_PS2_CENTURY_BYTE 0x37
491 static void rtc_set_date_from_host(RTCState
*s
)
496 /* set the CMOS date */
497 qemu_get_timedate(&tm
, 0);
498 rtc_set_date(s
, &tm
);
500 val
= to_bcd(s
, (tm
.tm_year
/ 100) + 19);
501 rtc_set_memory(s
, REG_IBM_CENTURY_BYTE
, val
);
502 rtc_set_memory(s
, REG_IBM_PS2_CENTURY_BYTE
, val
);
505 static int rtc_post_load(void *opaque
, int version_id
)
508 RTCState
*s
= opaque
;
510 if (version_id
>= 2) {
512 rtc_coalesced_timer_update(s
);
519 static const VMStateDescription vmstate_rtc
= {
520 .name
= "mc146818rtc",
522 .minimum_version_id
= 1,
523 .minimum_version_id_old
= 1,
524 .post_load
= rtc_post_load
,
525 .fields
= (VMStateField
[]) {
526 VMSTATE_BUFFER(cmos_data
, RTCState
),
527 VMSTATE_UINT8(cmos_index
, RTCState
),
528 VMSTATE_INT32(current_tm
.tm_sec
, RTCState
),
529 VMSTATE_INT32(current_tm
.tm_min
, RTCState
),
530 VMSTATE_INT32(current_tm
.tm_hour
, RTCState
),
531 VMSTATE_INT32(current_tm
.tm_wday
, RTCState
),
532 VMSTATE_INT32(current_tm
.tm_mday
, RTCState
),
533 VMSTATE_INT32(current_tm
.tm_mon
, RTCState
),
534 VMSTATE_INT32(current_tm
.tm_year
, RTCState
),
535 VMSTATE_TIMER(periodic_timer
, RTCState
),
536 VMSTATE_INT64(next_periodic_time
, RTCState
),
537 VMSTATE_INT64(next_second_time
, RTCState
),
538 VMSTATE_TIMER(second_timer
, RTCState
),
539 VMSTATE_TIMER(second_timer2
, RTCState
),
540 VMSTATE_UINT32_V(irq_coalesced
, RTCState
, 2),
541 VMSTATE_UINT32_V(period
, RTCState
, 2),
542 VMSTATE_END_OF_LIST()
546 static void rtc_reset(void *opaque
)
548 RTCState
*s
= opaque
;
550 s
->cmos_data
[RTC_REG_B
] &= ~(REG_B_PIE
| REG_B_AIE
| REG_B_SQWE
);
551 s
->cmos_data
[RTC_REG_C
] &= ~(REG_C_UF
| REG_C_IRQF
| REG_C_PF
| REG_C_AF
);
553 qemu_irq_lower(s
->irq
);
557 s
->irq_coalesced
= 0;
561 static int rtc_initfn(ISADevice
*dev
)
563 RTCState
*s
= DO_UPCAST(RTCState
, dev
, dev
);
567 isa_init_irq(dev
, &s
->irq
, isairq
);
569 s
->cmos_data
[RTC_REG_A
] = 0x26;
570 s
->cmos_data
[RTC_REG_B
] = 0x02;
571 s
->cmos_data
[RTC_REG_C
] = 0x00;
572 s
->cmos_data
[RTC_REG_D
] = 0x80;
574 rtc_set_date_from_host(s
);
576 s
->periodic_timer
= qemu_new_timer(rtc_clock
, rtc_periodic_timer
, s
);
580 qemu_new_timer(rtc_clock
, rtc_coalesced_timer
, s
);
582 s
->second_timer
= qemu_new_timer(rtc_clock
, rtc_update_second
, s
);
583 s
->second_timer2
= qemu_new_timer(rtc_clock
, rtc_update_second2
, s
);
585 s
->next_second_time
=
586 qemu_get_clock(rtc_clock
) + (get_ticks_per_sec() * 99) / 100;
587 qemu_mod_timer(s
->second_timer2
, s
->next_second_time
);
589 register_ioport_write(base
, 2, 1, cmos_ioport_write
, s
);
590 register_ioport_read(base
, 2, 1, cmos_ioport_read
, s
);
592 vmstate_register(base
, &vmstate_rtc
, s
);
593 qemu_register_reset(rtc_reset
, s
);
597 RTCState
*rtc_init(int base_year
)
601 dev
= isa_create("mc146818rtc");
602 qdev_prop_set_int32(&dev
->qdev
, "base_year", base_year
);
603 qdev_init_nofail(&dev
->qdev
);
604 return DO_UPCAST(RTCState
, dev
, dev
);
607 static ISADeviceInfo mc146818rtc_info
= {
608 .qdev
.name
= "mc146818rtc",
609 .qdev
.size
= sizeof(RTCState
),
612 .qdev
.props
= (Property
[]) {
613 DEFINE_PROP_INT32("base_year", RTCState
, base_year
, 1980),
614 DEFINE_PROP_END_OF_LIST(),
618 static void mc146818rtc_register(void)
620 isa_qdev_register(&mc146818rtc_info
);
622 device_init(mc146818rtc_register
)