[mirror_ubuntu-jammy-kernel.git] / include / kvm / arm_arch_timer.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2012 ARM Ltd.
 * Author: Marc Zyngier <marc.zyngier@arm.com>
 */

#ifndef __ASM_ARM_KVM_ARCH_TIMER_H
#define __ASM_ARM_KVM_ARCH_TIMER_H

#include <linux/clocksource.h>
#include <linux/hrtimer.h>

enum kvm_arch_timers {
	TIMER_PTIMER,
	TIMER_VTIMER,
	NR_KVM_TIMERS
};

enum kvm_arch_timer_regs {
	TIMER_REG_CNT,
	TIMER_REG_CVAL,
	TIMER_REG_TVAL,
	TIMER_REG_CTL,
};

struct arch_timer_context {
	struct kvm_vcpu			*vcpu;

	/* Registers: control register, timer value */
	u32				cnt_ctl;
	u64				cnt_cval;

	/* Timer IRQ */
	struct kvm_irq_level		irq;

	/* Virtual offset */
	u64				cntvoff;

	/* Emulated Timer (may be unused) */
	struct hrtimer			hrtimer;

	/*
	 * We have multiple paths which can save/restore the timer state onto
	 * the hardware, so we need some way of keeping track of where the
	 * latest state is.
	 */
	bool				loaded;

	/* Duplicated state from arch_timer.c for convenience */
	u32				host_timer_irq;
	u32				host_timer_irq_flags;
};

struct timer_map {
	struct arch_timer_context *direct_vtimer;
	struct arch_timer_context *direct_ptimer;
	struct arch_timer_context *emul_ptimer;
};

struct arch_timer_cpu {
	struct arch_timer_context timers[NR_KVM_TIMERS];

	/* Background timer used when the guest is not running */
	struct hrtimer			bg_timer;

	/* Is the timer enabled */
	bool			enabled;
};

int kvm_timer_hyp_init(bool);
int kvm_timer_enable(struct kvm_vcpu *vcpu);
int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
void kvm_timer_sync_hwstate(struct kvm_vcpu *vcpu);
bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
void kvm_timer_update_run(struct kvm_vcpu *vcpu);
void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);

u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);

int kvm_arm_timer_set_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
int kvm_arm_timer_get_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);
int kvm_arm_timer_has_attr(struct kvm_vcpu *vcpu, struct kvm_device_attr *attr);

bool kvm_timer_is_pending(struct kvm_vcpu *vcpu);

u64 kvm_phys_timer_read(void);

void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);

void kvm_timer_init_vhe(void);

bool kvm_arch_timer_get_input_level(int vintid);

#define vcpu_timer(v)	(&(v)->arch.timer_cpu)
#define vcpu_get_timer(v,t)	(&vcpu_timer(v)->timers[(t)])
#define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_VTIMER])
#define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.timers[TIMER_PTIMER])

#define arch_timer_ctx_index(ctx)	((ctx) - vcpu_timer((ctx)->vcpu)->timers)

u64 kvm_arm_timer_read_sysreg(struct kvm_vcpu *vcpu,
			      enum kvm_arch_timers tmr,
			      enum kvm_arch_timer_regs treg);
void kvm_arm_timer_write_sysreg(struct kvm_vcpu *vcpu,
				enum kvm_arch_timers tmr,
				enum kvm_arch_timer_regs treg,
				u64 val);

#endif
Commit	Line	Data
45051539	1	/* SPDX-License-Identifier: GPL-2.0-only */
53e72406 MZ	2	/*
	3	* Copyright (C) 2012 ARM Ltd.
	4	* Author: Marc Zyngier <marc.zyngier@arm.com>
53e72406 MZ	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>
53e72406	12
84135d3d AP	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
fbb4aeec	26	struct arch_timer_context {
e604dd5d CD	27	struct kvm_vcpu *vcpu;
e604dd5d CD	28
53e72406	29	/* Registers: control register, timer value */
fbb4aeec JL	30	u32 cnt_ctl;
	31	u64 cnt_cval;
	32
	33	/* Timer IRQ */
	34	struct kvm_irq_level irq;
	35
90de943a	36	/* Virtual offset */
e604dd5d CD	37	u64 cntvoff;
	38
	39	/* Emulated Timer (may be unused) */
	40	struct hrtimer hrtimer;
9e01dc76	41
bee038a6 CD	42	/*
	43	* We have multiple paths which can save/restore the timer state onto
	44	* the hardware, so we need some way of keeping track of where the
	45	* latest state is.
	46	*/
	47	bool loaded;
	48
9e01dc76 CD	49	/* Duplicated state from arch_timer.c for convenience */
	50	u32 host_timer_irq;
	51	u32 host_timer_irq_flags;
fbb4aeec	52	};
53e72406	53
bee038a6 CD	54	struct timer_map {
	55	struct arch_timer_context *direct_vtimer;
	56	struct arch_timer_context *direct_ptimer;
	57	struct arch_timer_context *emul_ptimer;
	58	};
	59
fbb4aeec	60	struct arch_timer_cpu {
e604dd5d	61	struct arch_timer_context timers[NR_KVM_TIMERS];
53e72406 MZ	62
53e72406 MZ	63	/* Background timer used when the guest is not running */
14d61fa9	64	struct hrtimer bg_timer;
53e72406	65
41a54482 CD	66	/* Is the timer enabled */
41a54482 CD	67	bool enabled;
53e72406 MZ	68	};
53e72406 MZ	69
f384dcfe	70	int kvm_timer_hyp_init(bool);
41a54482	71	int kvm_timer_enable(struct kvm_vcpu *vcpu);
85e69ad7	72	int kvm_timer_vcpu_reset(struct kvm_vcpu *vcpu);
53e72406	73	void kvm_timer_vcpu_init(struct kvm_vcpu *vcpu);
53e72406	74	void kvm_timer_sync_hwstate(struct kvm_vcpu *vcpu);
d9e13977 AG	75	bool kvm_timer_should_notify_user(struct kvm_vcpu *vcpu);
d9e13977 AG	76	void kvm_timer_update_run(struct kvm_vcpu *vcpu);
53e72406	77	void kvm_timer_vcpu_terminate(struct kvm_vcpu *vcpu);
1df08ba0 AB	78
	79	u64 kvm_arm_timer_get_reg(struct kvm_vcpu *, u64 regid);
	80	int kvm_arm_timer_set_reg(struct kvm_vcpu *, u64 regid, u64 value);
	81
99a1db7a CD	82	int kvm_arm_timer_set_attr(struct kvm_vcpu vcpu, struct kvm_device_attr attr);
	83	int kvm_arm_timer_get_attr(struct kvm_vcpu vcpu, struct kvm_device_attr attr);
	84	int kvm_arm_timer_has_attr(struct kvm_vcpu vcpu, struct kvm_device_attr attr);
	85
1c88ab7e CD	86	bool kvm_timer_is_pending(struct kvm_vcpu *vcpu);
1c88ab7e CD	87
7b6b4631 JL	88	u64 kvm_phys_timer_read(void);
7b6b4631 JL	89
b103cc3f	90	void kvm_timer_vcpu_load(struct kvm_vcpu *vcpu);
9b4a3004 MZ	91	void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);
9b4a3004 MZ	92
488f94d7	93	void kvm_timer_init_vhe(void);
fbb4aeec	94
4c60e360 CD	95	bool kvm_arch_timer_get_input_level(int vintid);
4c60e360 CD	96
e604dd5d CD	97	#define vcpu_timer(v) (&(v)->arch.timer_cpu)
	98	#define vcpu_get_timer(v,t) (&vcpu_timer(v)->timers[(t)])
	99	#define vcpu_vtimer(v) (&(v)->arch.timer_cpu.timers[TIMER_VTIMER])
	100	#define vcpu_ptimer(v) (&(v)->arch.timer_cpu.timers[TIMER_PTIMER])
84135d3d	101
9e01dc76 CD	102	#define arch_timer_ctx_index(ctx) ((ctx) - vcpu_timer((ctx)->vcpu)->timers)
9e01dc76 CD	103
84135d3d AP	104	u64 kvm_arm_timer_read_sysreg(struct kvm_vcpu *vcpu,
	105	enum kvm_arch_timers tmr,
	106	enum kvm_arch_timer_regs treg);
	107	void kvm_arm_timer_write_sysreg(struct kvm_vcpu *vcpu,
	108	enum kvm_arch_timers tmr,
	109	enum kvm_arch_timer_regs treg,
	110	u64 val);
b103cc3f	111
53e72406	112	#endif