2 * 8253/8254 interval timer emulation
4 * Copyright (c) 2003-2004 Fabrice Bellard
5 * Copyright (c) 2006 Intel Corporation
6 * Copyright (c) 2007 Keir Fraser, XenSource Inc
7 * Copyright (c) 2008 Intel Corporation
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 * Sheng Yang <sheng.yang@intel.com>
29 * Based on QEMU and Xen.
32 #include <linux/kvm_host.h>
38 #define mod_64(x, y) ((x) - (y) * div64_u64(x, y))
40 #define mod_64(x, y) ((x) % (y))
43 #define RW_STATE_LSB 1
44 #define RW_STATE_MSB 2
45 #define RW_STATE_WORD0 3
46 #define RW_STATE_WORD1 4
48 /* Compute with 96 bit intermediate result: (a*b)/c */
49 static u64
muldiv64(u64 a
, u32 b
, u32 c
)
60 rl
= (u64
)u
.l
.low
* (u64
)b
;
61 rh
= (u64
)u
.l
.high
* (u64
)b
;
63 res
.l
.high
= div64_u64(rh
, c
);
64 res
.l
.low
= div64_u64(((mod_64(rh
, c
) << 32) + (rl
& 0xffffffff)), c
);
68 static void pit_set_gate(struct kvm
*kvm
, int channel
, u32 val
)
70 struct kvm_kpit_channel_state
*c
=
71 &kvm
->arch
.vpit
->pit_state
.channels
[channel
];
73 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
79 /* XXX: just disable/enable counting */
85 /* Restart counting on rising edge. */
87 c
->count_load_time
= ktime_get();
94 static int pit_get_gate(struct kvm
*kvm
, int channel
)
96 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
98 return kvm
->arch
.vpit
->pit_state
.channels
[channel
].gate
;
101 static int pit_get_count(struct kvm
*kvm
, int channel
)
103 struct kvm_kpit_channel_state
*c
=
104 &kvm
->arch
.vpit
->pit_state
.channels
[channel
];
108 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
110 t
= ktime_to_ns(ktime_sub(ktime_get(), c
->count_load_time
));
111 d
= muldiv64(t
, KVM_PIT_FREQ
, NSEC_PER_SEC
);
118 counter
= (c
->count
- d
) & 0xffff;
121 /* XXX: may be incorrect for odd counts */
122 counter
= c
->count
- (mod_64((2 * d
), c
->count
));
125 counter
= c
->count
- mod_64(d
, c
->count
);
131 static int pit_get_out(struct kvm
*kvm
, int channel
)
133 struct kvm_kpit_channel_state
*c
=
134 &kvm
->arch
.vpit
->pit_state
.channels
[channel
];
138 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
140 t
= ktime_to_ns(ktime_sub(ktime_get(), c
->count_load_time
));
141 d
= muldiv64(t
, KVM_PIT_FREQ
, NSEC_PER_SEC
);
146 out
= (d
>= c
->count
);
149 out
= (d
< c
->count
);
152 out
= ((mod_64(d
, c
->count
) == 0) && (d
!= 0));
155 out
= (mod_64(d
, c
->count
) < ((c
->count
+ 1) >> 1));
159 out
= (d
== c
->count
);
166 static void pit_latch_count(struct kvm
*kvm
, int channel
)
168 struct kvm_kpit_channel_state
*c
=
169 &kvm
->arch
.vpit
->pit_state
.channels
[channel
];
171 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
173 if (!c
->count_latched
) {
174 c
->latched_count
= pit_get_count(kvm
, channel
);
175 c
->count_latched
= c
->rw_mode
;
179 static void pit_latch_status(struct kvm
*kvm
, int channel
)
181 struct kvm_kpit_channel_state
*c
=
182 &kvm
->arch
.vpit
->pit_state
.channels
[channel
];
184 WARN_ON(!mutex_is_locked(&kvm
->arch
.vpit
->pit_state
.lock
));
186 if (!c
->status_latched
) {
187 /* TODO: Return NULL COUNT (bit 6). */
188 c
->status
= ((pit_get_out(kvm
, channel
) << 7) |
192 c
->status_latched
= 1;
196 static int __pit_timer_fn(struct kvm_kpit_state
*ps
)
198 struct kvm_vcpu
*vcpu0
= ps
->pit
->kvm
->vcpus
[0];
199 struct kvm_kpit_timer
*pt
= &ps
->pit_timer
;
201 if (!atomic_inc_and_test(&pt
->pending
))
202 set_bit(KVM_REQ_PENDING_TIMER
, &vcpu0
->requests
);
203 if (vcpu0
&& waitqueue_active(&vcpu0
->wq
)) {
204 vcpu0
->arch
.mp_state
= KVM_MP_STATE_RUNNABLE
;
205 wake_up_interruptible(&vcpu0
->wq
);
208 pt
->timer
.expires
= ktime_add_ns(pt
->timer
.expires
, pt
->period
);
209 pt
->scheduled
= ktime_to_ns(pt
->timer
.expires
);
211 ps
->channels
[0].count_load_time
= pt
->timer
.expires
;
213 return (pt
->period
== 0 ? 0 : 1);
216 int pit_has_pending_timer(struct kvm_vcpu
*vcpu
)
218 struct kvm_pit
*pit
= vcpu
->kvm
->arch
.vpit
;
220 if (pit
&& vcpu
->vcpu_id
== 0 && pit
->pit_state
.irq_ack
)
221 return atomic_read(&pit
->pit_state
.pit_timer
.pending
);
225 void kvm_pit_ack_irq(struct kvm_irq_ack_notifier
*kian
)
227 struct kvm_kpit_state
*ps
= container_of(kian
, struct kvm_kpit_state
,
229 spin_lock(&ps
->inject_lock
);
230 if (atomic_dec_return(&ps
->pit_timer
.pending
) < 0)
233 spin_unlock(&ps
->inject_lock
);
236 static enum hrtimer_restart
pit_timer_fn(struct hrtimer
*data
)
238 struct kvm_kpit_state
*ps
;
239 int restart_timer
= 0;
241 ps
= container_of(data
, struct kvm_kpit_state
, pit_timer
.timer
);
243 restart_timer
= __pit_timer_fn(ps
);
246 return HRTIMER_RESTART
;
248 return HRTIMER_NORESTART
;
251 void __kvm_migrate_pit_timer(struct kvm_vcpu
*vcpu
)
253 struct kvm_pit
*pit
= vcpu
->kvm
->arch
.vpit
;
254 struct hrtimer
*timer
;
256 if (vcpu
->vcpu_id
!= 0 || !pit
)
259 timer
= &pit
->pit_state
.pit_timer
.timer
;
260 if (hrtimer_cancel(timer
))
261 hrtimer_start(timer
, timer
->expires
, HRTIMER_MODE_ABS
);
264 static void destroy_pit_timer(struct kvm_kpit_timer
*pt
)
266 pr_debug("pit: execute del timer!\n");
267 hrtimer_cancel(&pt
->timer
);
270 static void create_pit_timer(struct kvm_kpit_state
*ps
, u32 val
, int is_period
)
272 struct kvm_kpit_timer
*pt
= &ps
->pit_timer
;
275 interval
= muldiv64(val
, NSEC_PER_SEC
, KVM_PIT_FREQ
);
277 pr_debug("pit: create pit timer, interval is %llu nsec\n", interval
);
279 /* TODO The new value only affected after the retriggered */
280 hrtimer_cancel(&pt
->timer
);
281 pt
->period
= (is_period
== 0) ? 0 : interval
;
282 pt
->timer
.function
= pit_timer_fn
;
283 atomic_set(&pt
->pending
, 0);
286 hrtimer_start(&pt
->timer
, ktime_add_ns(ktime_get(), interval
),
290 static void pit_load_count(struct kvm
*kvm
, int channel
, u32 val
)
292 struct kvm_kpit_state
*ps
= &kvm
->arch
.vpit
->pit_state
;
294 WARN_ON(!mutex_is_locked(&ps
->lock
));
296 pr_debug("pit: load_count val is %d, channel is %d\n", val
, channel
);
299 * Though spec said the state of 8254 is undefined after power-up,
300 * seems some tricky OS like Windows XP depends on IRQ0 interrupt
302 * So here setting initialize rate for it, and not a specific number
307 ps
->channels
[channel
].count_load_time
= ktime_get();
308 ps
->channels
[channel
].count
= val
;
313 /* Two types of timer
314 * mode 1 is one shot, mode 2 is period, otherwise del timer */
315 switch (ps
->channels
[0].mode
) {
317 /* FIXME: enhance mode 4 precision */
319 create_pit_timer(ps
, val
, 0);
323 create_pit_timer(ps
, val
, 1);
326 destroy_pit_timer(&ps
->pit_timer
);
330 void kvm_pit_load_count(struct kvm
*kvm
, int channel
, u32 val
)
332 mutex_lock(&kvm
->arch
.vpit
->pit_state
.lock
);
333 pit_load_count(kvm
, channel
, val
);
334 mutex_unlock(&kvm
->arch
.vpit
->pit_state
.lock
);
337 static void pit_ioport_write(struct kvm_io_device
*this,
338 gpa_t addr
, int len
, const void *data
)
340 struct kvm_pit
*pit
= (struct kvm_pit
*)this->private;
341 struct kvm_kpit_state
*pit_state
= &pit
->pit_state
;
342 struct kvm
*kvm
= pit
->kvm
;
344 struct kvm_kpit_channel_state
*s
;
345 u32 val
= *(u32
*) data
;
348 addr
&= KVM_PIT_CHANNEL_MASK
;
350 mutex_lock(&pit_state
->lock
);
353 pr_debug("pit: write addr is 0x%x, len is %d, val is 0x%x\n",
354 (unsigned int)addr
, len
, val
);
359 /* Read-Back Command. */
360 for (channel
= 0; channel
< 3; channel
++) {
361 s
= &pit_state
->channels
[channel
];
362 if (val
& (2 << channel
)) {
364 pit_latch_count(kvm
, channel
);
366 pit_latch_status(kvm
, channel
);
370 /* Select Counter <channel>. */
371 s
= &pit_state
->channels
[channel
];
372 access
= (val
>> 4) & KVM_PIT_CHANNEL_MASK
;
374 pit_latch_count(kvm
, channel
);
377 s
->read_state
= access
;
378 s
->write_state
= access
;
379 s
->mode
= (val
>> 1) & 7;
387 s
= &pit_state
->channels
[addr
];
388 switch (s
->write_state
) {
391 pit_load_count(kvm
, addr
, val
);
394 pit_load_count(kvm
, addr
, val
<< 8);
397 s
->write_latch
= val
;
398 s
->write_state
= RW_STATE_WORD1
;
401 pit_load_count(kvm
, addr
, s
->write_latch
| (val
<< 8));
402 s
->write_state
= RW_STATE_WORD0
;
407 mutex_unlock(&pit_state
->lock
);
410 static void pit_ioport_read(struct kvm_io_device
*this,
411 gpa_t addr
, int len
, void *data
)
413 struct kvm_pit
*pit
= (struct kvm_pit
*)this->private;
414 struct kvm_kpit_state
*pit_state
= &pit
->pit_state
;
415 struct kvm
*kvm
= pit
->kvm
;
417 struct kvm_kpit_channel_state
*s
;
419 addr
&= KVM_PIT_CHANNEL_MASK
;
420 s
= &pit_state
->channels
[addr
];
422 mutex_lock(&pit_state
->lock
);
424 if (s
->status_latched
) {
425 s
->status_latched
= 0;
427 } else if (s
->count_latched
) {
428 switch (s
->count_latched
) {
431 ret
= s
->latched_count
& 0xff;
432 s
->count_latched
= 0;
435 ret
= s
->latched_count
>> 8;
436 s
->count_latched
= 0;
439 ret
= s
->latched_count
& 0xff;
440 s
->count_latched
= RW_STATE_MSB
;
444 switch (s
->read_state
) {
447 count
= pit_get_count(kvm
, addr
);
451 count
= pit_get_count(kvm
, addr
);
452 ret
= (count
>> 8) & 0xff;
455 count
= pit_get_count(kvm
, addr
);
457 s
->read_state
= RW_STATE_WORD1
;
460 count
= pit_get_count(kvm
, addr
);
461 ret
= (count
>> 8) & 0xff;
462 s
->read_state
= RW_STATE_WORD0
;
467 if (len
> sizeof(ret
))
469 memcpy(data
, (char *)&ret
, len
);
471 mutex_unlock(&pit_state
->lock
);
474 static int pit_in_range(struct kvm_io_device
*this, gpa_t addr
,
475 int len
, int is_write
)
477 return ((addr
>= KVM_PIT_BASE_ADDRESS
) &&
478 (addr
< KVM_PIT_BASE_ADDRESS
+ KVM_PIT_MEM_LENGTH
));
481 static void speaker_ioport_write(struct kvm_io_device
*this,
482 gpa_t addr
, int len
, const void *data
)
484 struct kvm_pit
*pit
= (struct kvm_pit
*)this->private;
485 struct kvm_kpit_state
*pit_state
= &pit
->pit_state
;
486 struct kvm
*kvm
= pit
->kvm
;
487 u32 val
= *(u32
*) data
;
489 mutex_lock(&pit_state
->lock
);
490 pit_state
->speaker_data_on
= (val
>> 1) & 1;
491 pit_set_gate(kvm
, 2, val
& 1);
492 mutex_unlock(&pit_state
->lock
);
495 static void speaker_ioport_read(struct kvm_io_device
*this,
496 gpa_t addr
, int len
, void *data
)
498 struct kvm_pit
*pit
= (struct kvm_pit
*)this->private;
499 struct kvm_kpit_state
*pit_state
= &pit
->pit_state
;
500 struct kvm
*kvm
= pit
->kvm
;
501 unsigned int refresh_clock
;
504 /* Refresh clock toggles at about 15us. We approximate as 2^14ns. */
505 refresh_clock
= ((unsigned int)ktime_to_ns(ktime_get()) >> 14) & 1;
507 mutex_lock(&pit_state
->lock
);
508 ret
= ((pit_state
->speaker_data_on
<< 1) | pit_get_gate(kvm
, 2) |
509 (pit_get_out(kvm
, 2) << 5) | (refresh_clock
<< 4));
510 if (len
> sizeof(ret
))
512 memcpy(data
, (char *)&ret
, len
);
513 mutex_unlock(&pit_state
->lock
);
516 static int speaker_in_range(struct kvm_io_device
*this, gpa_t addr
,
517 int len
, int is_write
)
519 return (addr
== KVM_SPEAKER_BASE_ADDRESS
);
522 void kvm_pit_reset(struct kvm_pit
*pit
)
525 struct kvm_kpit_channel_state
*c
;
527 mutex_lock(&pit
->pit_state
.lock
);
528 for (i
= 0; i
< 3; i
++) {
529 c
= &pit
->pit_state
.channels
[i
];
532 pit_load_count(pit
->kvm
, i
, 0);
534 mutex_unlock(&pit
->pit_state
.lock
);
536 atomic_set(&pit
->pit_state
.pit_timer
.pending
, 0);
537 pit
->pit_state
.irq_ack
= 1;
540 struct kvm_pit
*kvm_create_pit(struct kvm
*kvm
)
543 struct kvm_kpit_state
*pit_state
;
545 pit
= kzalloc(sizeof(struct kvm_pit
), GFP_KERNEL
);
549 mutex_init(&pit
->pit_state
.lock
);
550 mutex_lock(&pit
->pit_state
.lock
);
551 spin_lock_init(&pit
->pit_state
.inject_lock
);
553 /* Initialize PIO device */
554 pit
->dev
.read
= pit_ioport_read
;
555 pit
->dev
.write
= pit_ioport_write
;
556 pit
->dev
.in_range
= pit_in_range
;
557 pit
->dev
.private = pit
;
558 kvm_io_bus_register_dev(&kvm
->pio_bus
, &pit
->dev
);
560 pit
->speaker_dev
.read
= speaker_ioport_read
;
561 pit
->speaker_dev
.write
= speaker_ioport_write
;
562 pit
->speaker_dev
.in_range
= speaker_in_range
;
563 pit
->speaker_dev
.private = pit
;
564 kvm_io_bus_register_dev(&kvm
->pio_bus
, &pit
->speaker_dev
);
566 kvm
->arch
.vpit
= pit
;
569 pit_state
= &pit
->pit_state
;
570 pit_state
->pit
= pit
;
571 hrtimer_init(&pit_state
->pit_timer
.timer
,
572 CLOCK_MONOTONIC
, HRTIMER_MODE_ABS
);
573 pit_state
->irq_ack_notifier
.gsi
= 0;
574 pit_state
->irq_ack_notifier
.irq_acked
= kvm_pit_ack_irq
;
575 kvm_register_irq_ack_notifier(kvm
, &pit_state
->irq_ack_notifier
);
576 mutex_unlock(&pit
->pit_state
.lock
);
583 void kvm_free_pit(struct kvm
*kvm
)
585 struct hrtimer
*timer
;
587 if (kvm
->arch
.vpit
) {
588 mutex_lock(&kvm
->arch
.vpit
->pit_state
.lock
);
589 timer
= &kvm
->arch
.vpit
->pit_state
.pit_timer
.timer
;
590 hrtimer_cancel(timer
);
591 mutex_unlock(&kvm
->arch
.vpit
->pit_state
.lock
);
592 kfree(kvm
->arch
.vpit
);
596 static void __inject_pit_timer_intr(struct kvm
*kvm
)
598 mutex_lock(&kvm
->lock
);
599 kvm_ioapic_set_irq(kvm
->arch
.vioapic
, 0, 1);
600 kvm_ioapic_set_irq(kvm
->arch
.vioapic
, 0, 0);
601 kvm_pic_set_irq(pic_irqchip(kvm
), 0, 1);
602 kvm_pic_set_irq(pic_irqchip(kvm
), 0, 0);
603 mutex_unlock(&kvm
->lock
);
606 void kvm_inject_pit_timer_irqs(struct kvm_vcpu
*vcpu
)
608 struct kvm_pit
*pit
= vcpu
->kvm
->arch
.vpit
;
609 struct kvm
*kvm
= vcpu
->kvm
;
610 struct kvm_kpit_state
*ps
;
614 ps
= &pit
->pit_state
;
616 /* Try to inject pending interrupts when
617 * last one has been acked.
619 spin_lock(&ps
->inject_lock
);
620 if (atomic_read(&ps
->pit_timer
.pending
) && ps
->irq_ack
) {
624 spin_unlock(&ps
->inject_lock
);
626 __inject_pit_timer_intr(kvm
);