/*
   * Copyright (C) 2012 ARM Ltd.
   * Author: Marc Zyngier <marc.zyngier@arm.com>
   *
   * This program is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License version 2 as
   * published by the Free Software Foundation.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
   */
  
  #ifndef __ASM_ARM_KVM_ARCH_TIMER_H
  #define __ASM_ARM_KVM_ARCH_TIMER_H
  
  #include <linux/clocksource.h>
  #include <linux/hrtimer.h>
  #include <linux/workqueue.h>

  struct arch_timer_context {

  	/* Registers: control register, timer value */

  	u32				cnt_ctl;
  	u64				cnt_cval;
  
  	/* Timer IRQ */
  	struct kvm_irq_level		irq;
  
  	/* Active IRQ state caching */
  	bool				active_cleared_last;

  
  	/* Virtual offset */
  	u64			cntvoff;

  };

  struct arch_timer_cpu {
  	struct arch_timer_context	vtimer;

  	struct arch_timer_context	ptimer;

  
  	/* Background timer used when the guest is not running */
  	struct hrtimer			timer;
  
  	/* Work queued with the above timer expires */
  	struct work_struct		expired;
  
  	/* Background timer active */
  	bool				armed;

  	/* Is the timer enabled */
  	bool			enabled;

  };

  int kvm_timer_hyp_init(void);

  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_flush_hwstate(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_should_fire(struct arch_timer_context *timer_ctx);

  void kvm_timer_schedule(struct kvm_vcpu *vcpu);
  void kvm_timer_unschedule(struct kvm_vcpu *vcpu);

  u64 kvm_phys_timer_read(void);

  void kvm_timer_vcpu_put(struct kvm_vcpu *vcpu);

  void kvm_timer_init_vhe(void);

  
  #define vcpu_vtimer(v)	(&(v)->arch.timer_cpu.vtimer)

  #define vcpu_ptimer(v)	(&(v)->arch.timer_cpu.ptimer)

  #endif