include/kvm/arm_arch_timer.h

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