xref: /linux-6.15/include/kvm/arm_arch_timer.h (revision 8a5eb2d2)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2012 ARM Ltd.
4  * Author: Marc Zyngier <[email protected]>
5  */
6 
7 #ifndef __ASM_ARM_KVM_ARCH_TIMER_H
8 #define __ASM_ARM_KVM_ARCH_TIMER_H
9 
10 #include <linux/clocksource.h>
11 #include <linux/hrtimer.h>
12 
13 enum kvm_arch_timers {
14 	TIMER_PTIMER,
15 	TIMER_VTIMER,
16 	NR_KVM_TIMERS
17 };
18 
19 enum kvm_arch_timer_regs {
20 	TIMER_REG_CNT,
21 	TIMER_REG_CVAL,
22 	TIMER_REG_TVAL,
23 	TIMER_REG_CTL,
24 };
25 
26 struct arch_timer_offset {
27 	/*
28 	 * If set, pointer to one of the offsets in the kvm's offset
29 	 * structure. If NULL, assume a zero offset.
30 	 */
31 	u64	*vm_offset;
32 };
33 
34 struct arch_timer_vm_data {
35 	/* Offset applied to the virtual timer/counter */
36 	u64	voffset;
37 	/* Offset applied to the physical timer/counter */
38 	u64	poffset;
39 
40 	struct mutex	lock;
41 
42 	/* The PPI for each timer, global to the VM */
43 	u8	ppi[NR_KVM_TIMERS];
44 };
45 
46 struct arch_timer_context {
47 	struct kvm_vcpu			*vcpu;
48 
49 	/* Emulated Timer (may be unused) */
50 	struct hrtimer			hrtimer;
51 	u64				ns_frac;
52 
53 	/* Offset for this counter/timer */
54 	struct arch_timer_offset	offset;
55 	/*
56 	 * We have multiple paths which can save/restore the timer state onto
57 	 * the hardware, so we need some way of keeping track of where the
58 	 * latest state is.
59 	 */
60 	bool				loaded;
61 
62 	/* Output level of the timer IRQ */
63 	struct {
64 		bool			level;
65 	} irq;
66 
67 	/* Duplicated state from arch_timer.c for convenience */
68 	u32				host_timer_irq;
69 };
70 
71 struct timer_map {
72 	struct arch_timer_context *direct_vtimer;
73 	struct arch_timer_context *direct_ptimer;
74 	struct arch_timer_context *emul_ptimer;
75 };
76 
77 struct arch_timer_cpu {
78 	struct arch_timer_context timers[NR_KVM_TIMERS];
79 
80 	/* Background timer used when the guest is not running */
81 	struct hrtimer			bg_timer;
82 
83 	/* Is the timer enabled */
84 	bool			enabled;
85 };
86 
87 int __init kvm_timer_hyp_init(bool has_gic);
88 int kvm_timer_enable(struct kvm_vcpu *vcpu);
89 int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
90 void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
91 void kvm_timer_sync_user(struct kvm_vcpu *vcpu);
92 bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
93 void kvm_timer_update_run(struct kvm_vcpu *vcpu);
94 void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);
95 
96 void kvm_timer_init_vm(struct kvm *kvm);
97 
98 u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
99 int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);
100 
101 int kvm_arm_timer_set_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
102 int kvm_arm_timer_get_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
103 int kvm_arm_timer_has_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
104 
105 u64 kvm_phys_timer_read(void);
106 
107 void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
108 void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);
109 
110 void kvm_timer_init_vhe(void);
111 
112 bool kvm_arch_timer_get_input_level(int vintid);
113 
114 #define vcpu_timer(v)	(&(v)->arch.timer_cpu)
115 #define vcpu_get_timer(v,t)	(&vcpu_timer(v)->timers[(t)])
116 #define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_VTIMER])
117 #define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_PTIMER])
118 
119 #define arch_timer_ctx_index(ctx)	((ctx) - vcpu_timer((ctx)->vcpu)->timers)
120 
121 #define timer_vm_data(ctx)		(&(ctx)->vcpu->kvm->arch.timer_data)
122 #define timer_irq(ctx)			(timer_vm_data(ctx)->ppi[arch_timer_ctx_index(ctx)])
123 
124 u64 kvm_arm_timer_read_sysreg(struct kvm_vcpu *vcpu,
125 			      enum kvm_arch_timers tmr,
126 			      enum kvm_arch_timer_regs treg);
127 void kvm_arm_timer_write_sysreg(struct kvm_vcpu *vcpu,
128 				enum kvm_arch_timers tmr,
129 				enum kvm_arch_timer_regs treg,
130 				u64 val);
131 
132 /* Needed for tracing */
133 u32 timer_get_ctl(struct arch_timer_context *ctxt);
134 u64 timer_get_cval(struct arch_timer_context *ctxt);
135 
136 /* CPU HP callbacks */
137 void kvm_timer_cpu_up(void);
138 void kvm_timer_cpu_down(void);
139 
140 #endif
141