arch/arm64/kvm/sys_regs.h

   1 /*
   2  * Copyright (C) 2012,2013 - ARM Ltd
   3  * Author: Marc Zyngier <marc.zyngier@arm.com>
   4  *
   5  * Derived from arch/arm/kvm/coproc.h
   6  * Copyright (C) 2012 - Virtual Open Systems and Columbia University
   7  * Authors: Christoffer Dall <c.dall@virtualopensystems.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License, version 2, as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __ARM64_KVM_SYS_REGS_LOCAL_H__
  23 #define __ARM64_KVM_SYS_REGS_LOCAL_H__
  24
  25 struct sys_reg_params {
  26         u8      Op0;
  27         u8      Op1;
  28         u8      CRn;
  29         u8      CRm;
  30         u8      Op2;
  31         u64     regval;
  32         bool    is_write;
  33         bool    is_aarch32;
  34         bool    is_32bit;       /* Only valid if is_aarch32 is true */
  35 };
  36
  37 struct sys_reg_desc {
  38         /* Sysreg string for debug */
  39         const char *name;
  40
  41         /* MRS/MSR instruction which accesses it. */
  42         u8      Op0;
  43         u8      Op1;
  44         u8      CRn;
  45         u8      CRm;
  46         u8      Op2;
  47
  48         /* Trapped access from guest, if non-NULL. */
  49         bool (*access)(struct kvm_vcpu *,
  50                        struct sys_reg_params *,
  51                        const struct sys_reg_desc *);
  52
  53         /* Initialization for vcpu. */
  54         void (*reset)(struct kvm_vcpu *, const struct sys_reg_desc *);
  55
  56         /* Index into sys_reg[], or 0 if we don't need to save it. */
  57         int reg;
  58
  59         /* Value (usually reset value) */
  60         u64 val;
  61
  62         /* Custom get/set_user functions, fallback to generic if NULL */
  63         int (*get_user)(struct kvm_vcpu *vcpu, const struct sys_reg_desc *rd,
  64                         const struct kvm_one_reg *reg, void __user *uaddr);
  65         int (*set_user)(struct kvm_vcpu *vcpu, const struct sys_reg_desc *rd,
  66                         const struct kvm_one_reg *reg, void __user *uaddr);
  67 };
  68
  69 static inline void print_sys_reg_instr(const struct sys_reg_params *p)
  70 {
  71         /* Look, we even formatted it for you to paste into the table! */
  72         kvm_pr_unimpl(" { Op0(%2u), Op1(%2u), CRn(%2u), CRm(%2u), Op2(%2u), func_%s },\n",
  73                       p->Op0, p->Op1, p->CRn, p->CRm, p->Op2, p->is_write ? "write" : "read");
  74 }
  75
  76 static inline bool ignore_write(struct kvm_vcpu *vcpu,
  77                                 const struct sys_reg_params *p)
  78 {
  79         return true;
  80 }
  81
  82 static inline bool read_zero(struct kvm_vcpu *vcpu,
  83                              struct sys_reg_params *p)
  84 {
  85         p->regval = 0;
  86         return true;
  87 }
  88
  89 /* Reset functions */
  90 static inline void reset_unknown(struct kvm_vcpu *vcpu,
  91                                  const struct sys_reg_desc *r)
  92 {
  93         BUG_ON(!r->reg);
  94         BUG_ON(r->reg >= NR_SYS_REGS);
  95         __vcpu_sys_reg(vcpu, r->reg) = 0x1de7ec7edbadc0deULL;
  96 }
  97
  98 static inline void reset_val(struct kvm_vcpu *vcpu, const struct sys_reg_desc *r)
  99 {
 100         BUG_ON(!r->reg);
 101         BUG_ON(r->reg >= NR_SYS_REGS);
 102         __vcpu_sys_reg(vcpu, r->reg) = r->val;
 103 }
 104
 105 static inline int cmp_sys_reg(const struct sys_reg_desc *i1,
 106                               const struct sys_reg_desc *i2)
 107 {
 108         BUG_ON(i1 == i2);
 109         if (!i1)
 110                 return 1;
 111         else if (!i2)
 112                 return -1;
 113         if (i1->Op0 != i2->Op0)
 114                 return i1->Op0 - i2->Op0;
 115         if (i1->Op1 != i2->Op1)
 116                 return i1->Op1 - i2->Op1;
 117         if (i1->CRn != i2->CRn)
 118                 return i1->CRn - i2->CRn;
 119         if (i1->CRm != i2->CRm)
 120                 return i1->CRm - i2->CRm;
 121         return i1->Op2 - i2->Op2;
 122 }
 123
 124 const struct sys_reg_desc *find_reg_by_id(u64 id,
 125                                           struct sys_reg_params *params,
 126                                           const struct sys_reg_desc table[],
 127                                           unsigned int num);
 128
 129 #define Op0(_x)         .Op0 = _x
 130 #define Op1(_x)         .Op1 = _x
 131 #define CRn(_x)         .CRn = _x
 132 #define CRm(_x)         .CRm = _x
 133 #define Op2(_x)         .Op2 = _x
 134
 135 #define SYS_DESC(reg)                                   \
 136         .name = #reg,                                   \
 137         Op0(sys_reg_Op0(reg)), Op1(sys_reg_Op1(reg)),   \
 138         CRn(sys_reg_CRn(reg)), CRm(sys_reg_CRm(reg)),   \
 139         Op2(sys_reg_Op2(reg))
 140
 141 #endif /* __ARM64_KVM_SYS_REGS_LOCAL_H__ */