1 /*
2  * Copyright (C) 2012 ARM Ltd.
3  * Author: Marc Zyngier <marc.zyngier@arm.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 
19 #ifndef __ASM_ARM_KVM_ARCH_TIMER_H
20 #define __ASM_ARM_KVM_ARCH_TIMER_H
21 
22 #include <linux/clocksource.h>
23 #include <linux/hrtimer.h>
24 #include <linux/workqueue.h>
25 
26 struct arch_timer_context {
27 	/* Registers: control register, timer value */
28 	u32				cnt_ctl;
29 	u64				cnt_cval;
30 
31 	/* Timer IRQ */
32 	struct kvm_irq_level		irq;
33 
34 	/*
35 	 * We have multiple paths which can save/restore the timer state
36 	 * onto the hardware, so we need some way of keeping track of
37 	 * where the latest state is.
38 	 *
39 	 * loaded == true:  State is loaded on the hardware registers.
40 	 * loaded == false: State is stored in memory.
41 	 */
42 	bool			loaded;
43 
44 	/* Virtual offset */
45 	u64			cntvoff;
46 };
47 
48 struct arch_timer_cpu {
49 	struct arch_timer_context	vtimer;
50 	struct arch_timer_context	ptimer;
51 
52 	/* Background timer used when the guest is not running */
53 	struct hrtimer			bg_timer;
54 
55 	/* Work queued with the above timer expires */
56 	struct work_struct		expired;
57 
58 	/* Physical timer emulation */
59 	struct hrtimer			phys_timer;
60 
61 	/* Is the timer enabled */
62 	bool			enabled;
63 };
64 
65 int kvm_timer_hyp_init(bool);
66 int kvm_timer_enable(struct kvm_vcpu *vcpu);
67 int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
68 void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
69 void kvm_timer_sync_hwstate(struct kvm_vcpu *vcpu);
70 bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
71 void kvm_timer_update_run(struct kvm_vcpu *vcpu);
72 void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);
73 
74 u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
75 int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);
76 
77 int kvm_arm_timer_set_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
78 int kvm_arm_timer_get_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
79 int kvm_arm_timer_has_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
80 
81 bool kvm_timer_is_pending(struct kvm_vcpu *vcpu);
82 
83 void kvm_timer_schedule(struct kvm_vcpu *vcpu);
84 void kvm_timer_unschedule(struct kvm_vcpu *vcpu);
85 
86 u64 kvm_phys_timer_read(void);
87 
88 void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
89 void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);
90 
91 void kvm_timer_init_vhe(void);
92 
93 bool kvm_arch_timer_get_input_level(int vintid);
94 
95 #define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.vtimer)
96 #define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.ptimer)
97 
98 #endif
99