1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (C) 2012 ARM Ltd.
4 * Author: Marc Zyngier <marc.zyngier@arm.com>
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
13enum kvm_arch_timers {
14	TIMER_PTIMER,
15	TIMER_VTIMER,
16	NR_KVM_TIMERS
17};
18
19enum kvm_arch_timer_regs {
20	TIMER_REG_CNT,
21	TIMER_REG_CVAL,
22	TIMER_REG_TVAL,
23	TIMER_REG_CTL,
24};
25
26struct arch_timer_context {
27	struct kvm_vcpu			*vcpu;
28
29	/* Timer IRQ */
30	struct kvm_irq_level		irq;
31
32	/* Emulated Timer (may be unused) */
33	struct hrtimer			hrtimer;
34
35	/*
36	 * We have multiple paths which can save/restore the timer state onto
37	 * the hardware, so we need some way of keeping track of where the
38	 * latest state is.
39	 */
40	bool				loaded;
41
42	/* Duplicated state from arch_timer.c for convenience */
43	u32				host_timer_irq;
44	u32				host_timer_irq_flags;
45};
46
47struct timer_map {
48	struct arch_timer_context *direct_vtimer;
49	struct arch_timer_context *direct_ptimer;
50	struct arch_timer_context *emul_ptimer;
51};
52
53struct arch_timer_cpu {
54	struct arch_timer_context timers[NR_KVM_TIMERS];
55
56	/* Background timer used when the guest is not running */
57	struct hrtimer			bg_timer;
58
59	/* Is the timer enabled */
60	bool			enabled;
61};
62
63int kvm_timer_hyp_init(bool);
64int kvm_timer_enable(struct kvm_vcpu *vcpu);
65int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
66void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
67void kvm_timer_sync_user(struct kvm_vcpu *vcpu);
68bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
69void kvm_timer_update_run(struct kvm_vcpu *vcpu);
70void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);
71
72u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
73int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);
74
75int kvm_arm_timer_set_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
76int kvm_arm_timer_get_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
77int kvm_arm_timer_has_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
78
79bool kvm_timer_is_pending(struct kvm_vcpu *vcpu);
80
81u64 kvm_phys_timer_read(void);
82
83void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
84void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);
85
86void kvm_timer_init_vhe(void);
87
88bool kvm_arch_timer_get_input_level(int vintid);
89
90#define vcpu_timer(v)	(&(v)->arch.timer_cpu)
91#define vcpu_get_timer(v,t)	(&vcpu_timer(v)->timers[(t)])
92#define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_VTIMER])
93#define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_PTIMER])
94
95#define arch_timer_ctx_index(ctx)	((ctx) - vcpu_timer((ctx)->vcpu)->timers)
96
97u64 kvm_arm_timer_read_sysreg(struct kvm_vcpu *vcpu,
98			      enum kvm_arch_timers tmr,
99			      enum kvm_arch_timer_regs treg);
100void kvm_arm_timer_write_sysreg(struct kvm_vcpu *vcpu,
101				enum kvm_arch_timers tmr,
102				enum kvm_arch_timer_regs treg,
103				u64 val);
104
105/* Needed for tracing */
106u32 timer_get_ctl(struct arch_timer_context *ctxt);
107u64 timer_get_cval(struct arch_timer_context *ctxt);
108
109#endif
110