2 * High Precisition Event Timer emulation
4 * Copyright (c) 2007 Alexander Graf
5 * Copyright (c) 2008 IBM Corporation
7 * Authors: Beth Kon <bkon@us.ibm.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 * *****************************************************************
24 * This driver attempts to emulate an HPET device in software.
30 #include "qemu-timer.h"
31 #include "hpet_emul.h"
33 #include "mc146818rtc.h"
37 #define DPRINTF printf
43 typedef struct HPETTimer
{ /* timers */
44 uint8_t tn
; /*timer number*/
45 QEMUTimer
*qemu_timer
;
46 struct HPETState
*state
;
47 /* Memory-mapped, software visible timer registers */
48 uint64_t config
; /* configuration/cap */
49 uint64_t cmp
; /* comparator */
50 uint64_t fsb
; /* FSB route, not supported now */
51 /* Hidden register state */
52 uint64_t period
; /* Last value written to comparator */
53 uint8_t wrap_flag
; /* timer pop will indicate wrap for one-shot 32-bit
54 * mode. Next pop will be actual timer expiration.
58 typedef struct HPETState
{
61 qemu_irq irqs
[HPET_NUM_IRQ_ROUTES
];
62 uint8_t rtc_irq_level
;
63 HPETTimer timer
[HPET_NUM_TIMERS
];
65 /* Memory-mapped, software visible registers */
66 uint64_t capability
; /* capabilities */
67 uint64_t config
; /* configuration */
68 uint64_t isr
; /* interrupt status reg */
69 uint64_t hpet_counter
; /* main counter */
72 static uint32_t hpet_in_legacy_mode(HPETState
*s
)
74 return s
->config
& HPET_CFG_LEGACY
;
77 static uint32_t timer_int_route(struct HPETTimer
*timer
)
79 return (timer
->config
& HPET_TN_INT_ROUTE_MASK
) >> HPET_TN_INT_ROUTE_SHIFT
;
82 static uint32_t hpet_enabled(HPETState
*s
)
84 return s
->config
& HPET_CFG_ENABLE
;
87 static uint32_t timer_is_periodic(HPETTimer
*t
)
89 return t
->config
& HPET_TN_PERIODIC
;
92 static uint32_t timer_enabled(HPETTimer
*t
)
94 return t
->config
& HPET_TN_ENABLE
;
97 static uint32_t hpet_time_after(uint64_t a
, uint64_t b
)
99 return ((int32_t)(b
) - (int32_t)(a
) < 0);
102 static uint32_t hpet_time_after64(uint64_t a
, uint64_t b
)
104 return ((int64_t)(b
) - (int64_t)(a
) < 0);
107 static uint64_t ticks_to_ns(uint64_t value
)
109 return (muldiv64(value
, HPET_CLK_PERIOD
, FS_PER_NS
));
112 static uint64_t ns_to_ticks(uint64_t value
)
114 return (muldiv64(value
, FS_PER_NS
, HPET_CLK_PERIOD
));
117 static uint64_t hpet_fixup_reg(uint64_t new, uint64_t old
, uint64_t mask
)
124 static int activating_bit(uint64_t old
, uint64_t new, uint64_t mask
)
126 return (!(old
& mask
) && (new & mask
));
129 static int deactivating_bit(uint64_t old
, uint64_t new, uint64_t mask
)
131 return ((old
& mask
) && !(new & mask
));
134 static uint64_t hpet_get_ticks(HPETState
*s
)
136 return ns_to_ticks(qemu_get_clock(vm_clock
) + s
->hpet_offset
);
140 * calculate diff between comparator value and current ticks
142 static inline uint64_t hpet_calculate_diff(HPETTimer
*t
, uint64_t current
)
145 if (t
->config
& HPET_TN_32BIT
) {
148 cmp
= (uint32_t)t
->cmp
;
149 diff
= cmp
- (uint32_t)current
;
150 diff
= (int32_t)diff
> 0 ? diff
: (uint32_t)0;
151 return (uint64_t)diff
;
156 diff
= cmp
- current
;
157 diff
= (int64_t)diff
> 0 ? diff
: (uint64_t)0;
162 static void update_irq(struct HPETTimer
*timer
)
166 if (timer
->tn
<= 1 && hpet_in_legacy_mode(timer
->state
)) {
167 /* if LegacyReplacementRoute bit is set, HPET specification requires
168 * timer0 be routed to IRQ0 in NON-APIC or IRQ2 in the I/O APIC,
169 * timer1 be routed to IRQ8 in NON-APIC or IRQ8 in the I/O APIC.
171 route
= (timer
->tn
== 0) ? 0 : RTC_ISA_IRQ
;
173 route
= timer_int_route(timer
);
175 if (!timer_enabled(timer
) || !hpet_enabled(timer
->state
)) {
178 qemu_irq_pulse(timer
->state
->irqs
[route
]);
181 static void hpet_pre_save(void *opaque
)
183 HPETState
*s
= opaque
;
185 /* save current counter value */
186 s
->hpet_counter
= hpet_get_ticks(s
);
189 static int hpet_post_load(void *opaque
, int version_id
)
191 HPETState
*s
= opaque
;
193 /* Recalculate the offset between the main counter and guest time */
194 s
->hpet_offset
= ticks_to_ns(s
->hpet_counter
) - qemu_get_clock(vm_clock
);
198 static const VMStateDescription vmstate_hpet_timer
= {
199 .name
= "hpet_timer",
201 .minimum_version_id
= 1,
202 .minimum_version_id_old
= 1,
203 .fields
= (VMStateField
[]) {
204 VMSTATE_UINT8(tn
, HPETTimer
),
205 VMSTATE_UINT64(config
, HPETTimer
),
206 VMSTATE_UINT64(cmp
, HPETTimer
),
207 VMSTATE_UINT64(fsb
, HPETTimer
),
208 VMSTATE_UINT64(period
, HPETTimer
),
209 VMSTATE_UINT8(wrap_flag
, HPETTimer
),
210 VMSTATE_TIMER(qemu_timer
, HPETTimer
),
211 VMSTATE_END_OF_LIST()
215 static const VMStateDescription vmstate_hpet
= {
218 .minimum_version_id
= 1,
219 .minimum_version_id_old
= 1,
220 .pre_save
= hpet_pre_save
,
221 .post_load
= hpet_post_load
,
222 .fields
= (VMStateField
[]) {
223 VMSTATE_UINT64(config
, HPETState
),
224 VMSTATE_UINT64(isr
, HPETState
),
225 VMSTATE_UINT64(hpet_counter
, HPETState
),
226 VMSTATE_STRUCT_ARRAY(timer
, HPETState
, HPET_NUM_TIMERS
, 0,
227 vmstate_hpet_timer
, HPETTimer
),
228 VMSTATE_END_OF_LIST()
233 * timer expiration callback
235 static void hpet_timer(void *opaque
)
237 HPETTimer
*t
= opaque
;
240 uint64_t period
= t
->period
;
241 uint64_t cur_tick
= hpet_get_ticks(t
->state
);
243 if (timer_is_periodic(t
) && period
!= 0) {
244 if (t
->config
& HPET_TN_32BIT
) {
245 while (hpet_time_after(cur_tick
, t
->cmp
)) {
246 t
->cmp
= (uint32_t)(t
->cmp
+ t
->period
);
249 while (hpet_time_after64(cur_tick
, t
->cmp
)) {
253 diff
= hpet_calculate_diff(t
, cur_tick
);
254 qemu_mod_timer(t
->qemu_timer
,
255 qemu_get_clock(vm_clock
) + (int64_t)ticks_to_ns(diff
));
256 } else if (t
->config
& HPET_TN_32BIT
&& !timer_is_periodic(t
)) {
258 diff
= hpet_calculate_diff(t
, cur_tick
);
259 qemu_mod_timer(t
->qemu_timer
, qemu_get_clock(vm_clock
) +
260 (int64_t)ticks_to_ns(diff
));
267 static void hpet_set_timer(HPETTimer
*t
)
270 uint32_t wrap_diff
; /* how many ticks until we wrap? */
271 uint64_t cur_tick
= hpet_get_ticks(t
->state
);
273 /* whenever new timer is being set up, make sure wrap_flag is 0 */
275 diff
= hpet_calculate_diff(t
, cur_tick
);
277 /* hpet spec says in one-shot 32-bit mode, generate an interrupt when
278 * counter wraps in addition to an interrupt with comparator match.
280 if (t
->config
& HPET_TN_32BIT
&& !timer_is_periodic(t
)) {
281 wrap_diff
= 0xffffffff - (uint32_t)cur_tick
;
282 if (wrap_diff
< (uint32_t)diff
) {
287 qemu_mod_timer(t
->qemu_timer
,
288 qemu_get_clock(vm_clock
) + (int64_t)ticks_to_ns(diff
));
291 static void hpet_del_timer(HPETTimer
*t
)
293 qemu_del_timer(t
->qemu_timer
);
297 static uint32_t hpet_ram_readb(void *opaque
, target_phys_addr_t addr
)
299 printf("qemu: hpet_read b at %" PRIx64
"\n", addr
);
303 static uint32_t hpet_ram_readw(void *opaque
, target_phys_addr_t addr
)
305 printf("qemu: hpet_read w at %" PRIx64
"\n", addr
);
310 static uint32_t hpet_ram_readl(void *opaque
, target_phys_addr_t addr
)
312 HPETState
*s
= opaque
;
313 uint64_t cur_tick
, index
;
315 DPRINTF("qemu: Enter hpet_ram_readl at %" PRIx64
"\n", addr
);
317 /*address range of all TN regs*/
318 if (index
>= 0x100 && index
<= 0x3ff) {
319 uint8_t timer_id
= (addr
- 0x100) / 0x20;
320 HPETTimer
*timer
= &s
->timer
[timer_id
];
322 if (timer_id
> HPET_NUM_TIMERS
- 1) {
323 DPRINTF("qemu: timer id out of range\n");
327 switch ((addr
- 0x100) % 0x20) {
329 return timer
->config
;
330 case HPET_TN_CFG
+ 4: // Interrupt capabilities
331 return timer
->config
>> 32;
332 case HPET_TN_CMP
: // comparator register
334 case HPET_TN_CMP
+ 4:
335 return timer
->cmp
>> 32;
337 return timer
->fsb
>> 32;
339 DPRINTF("qemu: invalid hpet_ram_readl\n");
345 return s
->capability
;
347 return s
->capability
>> 32;
351 DPRINTF("qemu: invalid HPET_CFG + 4 hpet_ram_readl \n");
354 if (hpet_enabled(s
)) {
355 cur_tick
= hpet_get_ticks(s
);
357 cur_tick
= s
->hpet_counter
;
359 DPRINTF("qemu: reading counter = %" PRIx64
"\n", cur_tick
);
361 case HPET_COUNTER
+ 4:
362 if (hpet_enabled(s
)) {
363 cur_tick
= hpet_get_ticks(s
);
365 cur_tick
= s
->hpet_counter
;
367 DPRINTF("qemu: reading counter + 4 = %" PRIx64
"\n", cur_tick
);
368 return cur_tick
>> 32;
372 DPRINTF("qemu: invalid hpet_ram_readl\n");
380 static void hpet_ram_writeb(void *opaque
, target_phys_addr_t addr
,
383 printf("qemu: invalid hpet_write b at %" PRIx64
" = %#x\n",
387 static void hpet_ram_writew(void *opaque
, target_phys_addr_t addr
,
390 printf("qemu: invalid hpet_write w at %" PRIx64
" = %#x\n",
395 static void hpet_ram_writel(void *opaque
, target_phys_addr_t addr
,
399 HPETState
*s
= opaque
;
400 uint64_t old_val
, new_val
, val
, index
;
402 DPRINTF("qemu: Enter hpet_ram_writel at %" PRIx64
" = %#x\n", addr
, value
);
404 old_val
= hpet_ram_readl(opaque
, addr
);
407 /*address range of all TN regs*/
408 if (index
>= 0x100 && index
<= 0x3ff) {
409 uint8_t timer_id
= (addr
- 0x100) / 0x20;
410 HPETTimer
*timer
= &s
->timer
[timer_id
];
412 DPRINTF("qemu: hpet_ram_writel timer_id = %#x \n", timer_id
);
413 if (timer_id
> HPET_NUM_TIMERS
- 1) {
414 DPRINTF("qemu: timer id out of range\n");
417 switch ((addr
- 0x100) % 0x20) {
419 DPRINTF("qemu: hpet_ram_writel HPET_TN_CFG\n");
420 val
= hpet_fixup_reg(new_val
, old_val
, HPET_TN_CFG_WRITE_MASK
);
421 timer
->config
= (timer
->config
& 0xffffffff00000000ULL
) | val
;
422 if (new_val
& HPET_TN_32BIT
) {
423 timer
->cmp
= (uint32_t)timer
->cmp
;
424 timer
->period
= (uint32_t)timer
->period
;
426 if (new_val
& HPET_TN_TYPE_LEVEL
) {
427 printf("qemu: level-triggered hpet not supported\n");
430 if (activating_bit(old_val
, new_val
, HPET_TN_ENABLE
)) {
431 hpet_set_timer(timer
);
432 } else if (deactivating_bit(old_val
, new_val
, HPET_TN_ENABLE
)) {
433 hpet_del_timer(timer
);
436 case HPET_TN_CFG
+ 4: // Interrupt capabilities
437 DPRINTF("qemu: invalid HPET_TN_CFG+4 write\n");
439 case HPET_TN_CMP
: // comparator register
440 DPRINTF("qemu: hpet_ram_writel HPET_TN_CMP \n");
441 if (timer
->config
& HPET_TN_32BIT
) {
442 new_val
= (uint32_t)new_val
;
444 if (!timer_is_periodic(timer
)
445 || (timer
->config
& HPET_TN_SETVAL
)) {
446 timer
->cmp
= (timer
->cmp
& 0xffffffff00000000ULL
) | new_val
;
448 if (timer_is_periodic(timer
)) {
450 * FIXME: Clamp period to reasonable min value?
451 * Clamp period to reasonable max value
453 new_val
&= (timer
->config
& HPET_TN_32BIT
? ~0u : ~0ull) >> 1;
455 (timer
->period
& 0xffffffff00000000ULL
) | new_val
;
457 timer
->config
&= ~HPET_TN_SETVAL
;
458 if (hpet_enabled(s
)) {
459 hpet_set_timer(timer
);
462 case HPET_TN_CMP
+ 4: // comparator register high order
463 DPRINTF("qemu: hpet_ram_writel HPET_TN_CMP + 4\n");
464 if (!timer_is_periodic(timer
)
465 || (timer
->config
& HPET_TN_SETVAL
)) {
466 timer
->cmp
= (timer
->cmp
& 0xffffffffULL
) | new_val
<< 32;
469 * FIXME: Clamp period to reasonable min value?
470 * Clamp period to reasonable max value
472 new_val
&= (timer
->config
& HPET_TN_32BIT
? ~0u : ~0ull) >> 1;
474 (timer
->period
& 0xffffffffULL
) | new_val
<< 32;
476 timer
->config
&= ~HPET_TN_SETVAL
;
477 if (hpet_enabled(s
)) {
478 hpet_set_timer(timer
);
481 case HPET_TN_ROUTE
+ 4:
482 DPRINTF("qemu: hpet_ram_writel HPET_TN_ROUTE + 4\n");
485 DPRINTF("qemu: invalid hpet_ram_writel\n");
494 val
= hpet_fixup_reg(new_val
, old_val
, HPET_CFG_WRITE_MASK
);
495 s
->config
= (s
->config
& 0xffffffff00000000ULL
) | val
;
496 if (activating_bit(old_val
, new_val
, HPET_CFG_ENABLE
)) {
497 /* Enable main counter and interrupt generation. */
499 ticks_to_ns(s
->hpet_counter
) - qemu_get_clock(vm_clock
);
500 for (i
= 0; i
< HPET_NUM_TIMERS
; i
++) {
501 if ((&s
->timer
[i
])->cmp
!= ~0ULL) {
502 hpet_set_timer(&s
->timer
[i
]);
505 } else if (deactivating_bit(old_val
, new_val
, HPET_CFG_ENABLE
)) {
506 /* Halt main counter and disable interrupt generation. */
507 s
->hpet_counter
= hpet_get_ticks(s
);
508 for (i
= 0; i
< HPET_NUM_TIMERS
; i
++) {
509 hpet_del_timer(&s
->timer
[i
]);
512 /* i8254 and RTC are disabled when HPET is in legacy mode */
513 if (activating_bit(old_val
, new_val
, HPET_CFG_LEGACY
)) {
515 qemu_irq_lower(s
->irqs
[RTC_ISA_IRQ
]);
516 } else if (deactivating_bit(old_val
, new_val
, HPET_CFG_LEGACY
)) {
518 qemu_set_irq(s
->irqs
[RTC_ISA_IRQ
], s
->rtc_irq_level
);
522 DPRINTF("qemu: invalid HPET_CFG+4 write \n");
525 /* FIXME: need to handle level-triggered interrupts */
528 if (hpet_enabled(s
)) {
529 DPRINTF("qemu: Writing counter while HPET enabled!\n");
532 (s
->hpet_counter
& 0xffffffff00000000ULL
) | value
;
533 DPRINTF("qemu: HPET counter written. ctr = %#x -> %" PRIx64
"\n",
534 value
, s
->hpet_counter
);
536 case HPET_COUNTER
+ 4:
537 if (hpet_enabled(s
)) {
538 DPRINTF("qemu: Writing counter while HPET enabled!\n");
541 (s
->hpet_counter
& 0xffffffffULL
) | (((uint64_t)value
) << 32);
542 DPRINTF("qemu: HPET counter + 4 written. ctr = %#x -> %" PRIx64
"\n",
543 value
, s
->hpet_counter
);
546 DPRINTF("qemu: invalid hpet_ram_writel\n");
552 static CPUReadMemoryFunc
* const hpet_ram_read
[] = {
563 static CPUWriteMemoryFunc
* const hpet_ram_write
[] = {
574 static void hpet_reset(DeviceState
*d
)
576 HPETState
*s
= FROM_SYSBUS(HPETState
, sysbus_from_qdev(d
));
578 static int count
= 0;
580 for (i
= 0; i
< HPET_NUM_TIMERS
; i
++) {
581 HPETTimer
*timer
= &s
->timer
[i
];
583 hpet_del_timer(timer
);
585 timer
->config
= HPET_TN_PERIODIC_CAP
| HPET_TN_SIZE_CAP
;
586 /* advertise availability of ioapic inti2 */
587 timer
->config
|= 0x00000004ULL
<< 32;
588 timer
->period
= 0ULL;
589 timer
->wrap_flag
= 0;
592 s
->hpet_counter
= 0ULL;
593 s
->hpet_offset
= 0ULL;
594 /* 64-bit main counter; 3 timers supported; LegacyReplacementRoute. */
595 s
->capability
= 0x8086a201ULL
;
596 s
->capability
|= ((HPET_CLK_PERIOD
) << 32);
599 /* we don't enable pit when hpet_reset is first called (by hpet_init)
600 * because hpet is taking over for pit here. On subsequent invocations,
601 * hpet_reset is called due to system reset. At this point control must
602 * be returned to pit until SW reenables hpet.
609 static void hpet_handle_rtc_irq(void *opaque
, int n
, int level
)
611 HPETState
*s
= FROM_SYSBUS(HPETState
, opaque
);
613 s
->rtc_irq_level
= level
;
614 if (!hpet_in_legacy_mode(s
)) {
615 qemu_set_irq(s
->irqs
[RTC_ISA_IRQ
], level
);
619 static int hpet_init(SysBusDevice
*dev
)
621 HPETState
*s
= FROM_SYSBUS(HPETState
, dev
);
625 for (i
= 0; i
< HPET_NUM_IRQ_ROUTES
; i
++) {
626 sysbus_init_irq(dev
, &s
->irqs
[i
]);
628 for (i
= 0; i
< HPET_NUM_TIMERS
; i
++) {
629 timer
= &s
->timer
[i
];
630 timer
->qemu_timer
= qemu_new_timer(vm_clock
, hpet_timer
, timer
);
635 isa_reserve_irq(RTC_ISA_IRQ
);
636 qdev_init_gpio_in(&dev
->qdev
, hpet_handle_rtc_irq
, 1);
639 iomemtype
= cpu_register_io_memory(hpet_ram_read
,
641 sysbus_init_mmio(dev
, 0x400, iomemtype
);
645 static SysBusDeviceInfo hpet_device_info
= {
647 .qdev
.size
= sizeof(HPETState
),
649 .qdev
.vmsd
= &vmstate_hpet
,
650 .qdev
.reset
= hpet_reset
,
654 static void hpet_register_device(void)
656 sysbus_register_withprop(&hpet_device_info
);
659 device_init(hpet_register_device
)