xref: /openbmc/linux/include/kvm/arm_arch_timer.h (revision 1a59d1b8)
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 
25 enum kvm_arch_timers {
26 	TIMER_PTIMER,
27 	TIMER_VTIMER,
28 	NR_KVM_TIMERS
29 };
30 
31 enum kvm_arch_timer_regs {
32 	TIMER_REG_CNT,
33 	TIMER_REG_CVAL,
34 	TIMER_REG_TVAL,
35 	TIMER_REG_CTL,
36 };
37 
38 struct arch_timer_context {
39 	struct kvm_vcpu			*vcpu;
40 
41 	/* Registers: control register, timer value */
42 	u32				cnt_ctl;
43 	u64				cnt_cval;
44 
45 	/* Timer IRQ */
46 	struct kvm_irq_level		irq;
47 
48 	/* Virtual offset */
49 	u64				cntvoff;
50 
51 	/* Emulated Timer (may be unused) */
52 	struct hrtimer			hrtimer;
53 
54 	/*
55 	 * We have multiple paths which can save/restore the timer state onto
56 	 * the hardware, so we need some way of keeping track of where the
57 	 * latest state is.
58 	 */
59 	bool				loaded;
60 
61 	/* Duplicated state from arch_timer.c for convenience */
62 	u32				host_timer_irq;
63 	u32				host_timer_irq_flags;
64 };
65 
66 struct timer_map {
67 	struct arch_timer_context *direct_vtimer;
68 	struct arch_timer_context *direct_ptimer;
69 	struct arch_timer_context *emul_ptimer;
70 };
71 
72 struct arch_timer_cpu {
73 	struct arch_timer_context timers[NR_KVM_TIMERS];
74 
75 	/* Background timer used when the guest is not running */
76 	struct hrtimer			bg_timer;
77 
78 	/* Is the timer enabled */
79 	bool			enabled;
80 };
81 
82 int kvm_timer_hyp_init(bool);
83 int kvm_timer_enable(struct kvm_vcpu *vcpu);
84 int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
85 void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
86 void kvm_timer_sync_hwstate(struct kvm_vcpu *vcpu);
87 bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
88 void kvm_timer_update_run(struct kvm_vcpu *vcpu);
89 void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);
90 
91 u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
92 int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);
93 
94 int kvm_arm_timer_set_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
95 int kvm_arm_timer_get_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
96 int kvm_arm_timer_has_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
97 
98 bool kvm_timer_is_pending(struct kvm_vcpu *vcpu);
99 
100 u64 kvm_phys_timer_read(void);
101 
102 void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
103 void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);
104 
105 void kvm_timer_init_vhe(void);
106 
107 bool kvm_arch_timer_get_input_level(int vintid);
108 
109 #define vcpu_timer(v)	(&(v)->arch.timer_cpu)
110 #define vcpu_get_timer(v,t)	(&vcpu_timer(v)->timers[(t)])
111 #define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_VTIMER])
112 #define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_PTIMER])
113 
114 #define arch_timer_ctx_index(ctx)	((ctx) - vcpu_timer((ctx)->vcpu)->timers)
115 
116 u64 kvm_arm_timer_read_sysreg(struct kvm_vcpu *vcpu,
117 			      enum kvm_arch_timers tmr,
118 			      enum kvm_arch_timer_regs treg);
119 void kvm_arm_timer_write_sysreg(struct kvm_vcpu *vcpu,
120 				enum kvm_arch_timers tmr,
121 				enum kvm_arch_timer_regs treg,
122 				u64 val);
123 
124 #endif
125