[linux-2.6-block.git] / arch / arm64 / kvm / sys_regs.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2012,2013 - ARM Ltd
 * Author: Marc Zyngier <marc.zyngier@arm.com>
 *
 * Derived from arch/arm/kvm/coproc.h
 * Copyright (C) 2012 - Virtual Open Systems and Columbia University
 * Authors: Christoffer Dall <c.dall@virtualopensystems.com>
 */

#ifndef __ARM64_KVM_SYS_REGS_LOCAL_H__
#define __ARM64_KVM_SYS_REGS_LOCAL_H__

struct sys_reg_params {
	u8	Op0;
	u8	Op1;
	u8	CRn;
	u8	CRm;
	u8	Op2;
	u64	regval;
	bool	is_write;
	bool	is_aarch32;
	bool	is_32bit;	/* Only valid if is_aarch32 is true */
};

struct sys_reg_desc {
	/* Sysreg string for debug */
	const char *name;

	/* MRS/MSR instruction which accesses it. */
	u8	Op0;
	u8	Op1;
	u8	CRn;
	u8	CRm;
	u8	Op2;

	/* Trapped access from guest, if non-NULL. */
	bool (*access)(struct kvm_vcpu *,
		       struct sys_reg_params *,
		       const struct sys_reg_desc *);

	/* Initialization for vcpu. */
	void (*reset)(struct kvm_vcpu *, const struct sys_reg_desc *);

	/* Index into sys_reg[], or 0 if we don't need to save it. */
	int reg;

	/* Value (usually reset value) */
	u64 val;

	/* Custom get/set_user functions, fallback to generic if NULL */
	int (*get_user)(struct kvm_vcpu *vcpu, const struct sys_reg_desc *rd,
			const struct kvm_one_reg *reg, void __user *uaddr);
	int (*set_user)(struct kvm_vcpu *vcpu, const struct sys_reg_desc *rd,
			const struct kvm_one_reg *reg, void __user *uaddr);

	/* Return mask of REG_* runtime visibility overrides */
	unsigned int (*visibility)(const struct kvm_vcpu *vcpu,
				   const struct sys_reg_desc *rd);
};

#define REG_HIDDEN_USER		(1 << 0) /* hidden from userspace ioctls */
#define REG_HIDDEN_GUEST	(1 << 1) /* hidden from guest */

static inline void print_sys_reg_instr(const struct sys_reg_params *p)
{
	/* Look, we even formatted it for you to paste into the table! */
	kvm_pr_unimpl(" { Op0(%2u), Op1(%2u), CRn(%2u), CRm(%2u), Op2(%2u), func_%s },\n",
		      p->Op0, p->Op1, p->CRn, p->CRm, p->Op2, p->is_write ? "write" : "read");
}

static inline bool ignore_write(struct kvm_vcpu *vcpu,
				const struct sys_reg_params *p)
{
	return true;
}

static inline bool read_zero(struct kvm_vcpu *vcpu,
			     struct sys_reg_params *p)
{
	p->regval = 0;
	return true;
}

/* Reset functions */
static inline void reset_unknown(struct kvm_vcpu *vcpu,
				 const struct sys_reg_desc *r)
{
	BUG_ON(!r->reg);
	BUG_ON(r->reg >= NR_SYS_REGS);
	__vcpu_sys_reg(vcpu, r->reg) = 0x1de7ec7edbadc0deULL;
}

static inline void reset_val(struct kvm_vcpu *vcpu, const struct sys_reg_desc *r)
{
	BUG_ON(!r->reg);
	BUG_ON(r->reg >= NR_SYS_REGS);
	__vcpu_sys_reg(vcpu, r->reg) = r->val;
}

static inline bool sysreg_hidden_from_guest(const struct kvm_vcpu *vcpu,
					    const struct sys_reg_desc *r)
{
	if (likely(!r->visibility))
		return false;

	return r->visibility(vcpu, r) & REG_HIDDEN_GUEST;
}

static inline bool sysreg_hidden_from_user(const struct kvm_vcpu *vcpu,
					   const struct sys_reg_desc *r)
{
	if (likely(!r->visibility))
		return false;

	return r->visibility(vcpu, r) & REG_HIDDEN_USER;
}

static inline int cmp_sys_reg(const struct sys_reg_desc *i1,
			      const struct sys_reg_desc *i2)
{
	BUG_ON(i1 == i2);
	if (!i1)
		return 1;
	else if (!i2)
		return -1;
	if (i1->Op0 != i2->Op0)
		return i1->Op0 - i2->Op0;
	if (i1->Op1 != i2->Op1)
		return i1->Op1 - i2->Op1;
	if (i1->CRn != i2->CRn)
		return i1->CRn - i2->CRn;
	if (i1->CRm != i2->CRm)
		return i1->CRm - i2->CRm;
	return i1->Op2 - i2->Op2;
}

const struct sys_reg_desc *find_reg_by_id(u64 id,
					  struct sys_reg_params *params,
					  const struct sys_reg_desc table[],
					  unsigned int num);

#define Op0(_x) 	.Op0 = _x
#define Op1(_x) 	.Op1 = _x
#define CRn(_x)		.CRn = _x
#define CRm(_x) 	.CRm = _x
#define Op2(_x) 	.Op2 = _x

#define SYS_DESC(reg)					\
	.name = #reg,					\
	Op0(sys_reg_Op0(reg)), Op1(sys_reg_Op1(reg)),	\
	CRn(sys_reg_CRn(reg)), CRm(sys_reg_CRm(reg)),	\
	Op2(sys_reg_Op2(reg))

#endif /* __ARM64_KVM_SYS_REGS_LOCAL_H__ */
Commit	Line	Data
caab277b	1	/* SPDX-License-Identifier: GPL-2.0-only */
7c8c5e6a MZ	2	/*
	3	* Copyright (C) 2012,2013 - ARM Ltd
	4	* Author: Marc Zyngier <marc.zyngier@arm.com>
	5	*
	6	* Derived from arch/arm/kvm/coproc.h
	7	* Copyright (C) 2012 - Virtual Open Systems and Columbia University
	8	* Authors: Christoffer Dall <c.dall@virtualopensystems.com>
7c8c5e6a MZ	9	*/
	10
	11	#ifndef __ARM64_KVM_SYS_REGS_LOCAL_H__
	12	#define __ARM64_KVM_SYS_REGS_LOCAL_H__
	13
	14	struct sys_reg_params {
	15	u8 Op0;
	16	u8 Op1;
	17	u8 CRn;
	18	u8 CRm;
	19	u8 Op2;
2ec5be3d	20	u64 regval;
7c8c5e6a	21	bool is_write;
2072d29c MZ	22	bool is_aarch32;
2072d29c MZ	23	bool is_32bit; /* Only valid if is_aarch32 is true */
7c8c5e6a MZ	24	};
	25
	26	struct sys_reg_desc {
599d79dc MZ	27	/* Sysreg string for debug */
	28	const char *name;
	29
7c8c5e6a MZ	30	/* MRS/MSR instruction which accesses it. */
	31	u8 Op0;
	32	u8 Op1;
	33	u8 CRn;
	34	u8 CRm;
	35	u8 Op2;
	36
	37	/* Trapped access from guest, if non-NULL. */
	38	bool (access)(struct kvm_vcpu ,
3fec037d	39	struct sys_reg_params *,
7c8c5e6a MZ	40	const struct sys_reg_desc *);
	41
	42	/* Initialization for vcpu. */
	43	void (reset)(struct kvm_vcpu , const struct sys_reg_desc *);
	44
	45	/* Index into sys_reg[], or 0 if we don't need to save it. */
	46	int reg;
	47
	48	/* Value (usually reset value) */
	49	u64 val;
84e690bf AB	50
	51	/* Custom get/set_user functions, fallback to generic if NULL */
	52	int (get_user)(struct kvm_vcpu vcpu, const struct sys_reg_desc *rd,
	53	const struct kvm_one_reg reg, void __user uaddr);
	54	int (set_user)(struct kvm_vcpu vcpu, const struct sys_reg_desc *rd,
	55	const struct kvm_one_reg reg, void __user uaddr);
7f34e409 DM	56
	57	/* Return mask of REG_* runtime visibility overrides */
	58	unsigned int (visibility)(const struct kvm_vcpu vcpu,
	59	const struct sys_reg_desc *rd);
7c8c5e6a MZ	60	};
7c8c5e6a MZ	61
7f34e409 DM	62	#define REG_HIDDEN_USER (1 << 0) /* hidden from userspace ioctls */
	63	#define REG_HIDDEN_GUEST (1 << 1) /* hidden from guest */
	64
7c8c5e6a MZ	65	static inline void print_sys_reg_instr(const struct sys_reg_params *p)
	66	{
	67	/* Look, we even formatted it for you to paste into the table! */
	68	kvm_pr_unimpl(" { Op0(%2u), Op1(%2u), CRn(%2u), CRm(%2u), Op2(%2u), func_%s },\n",
	69	p->Op0, p->Op1, p->CRn, p->CRm, p->Op2, p->is_write ? "write" : "read");
	70	}
	71
	72	static inline bool ignore_write(struct kvm_vcpu *vcpu,
	73	const struct sys_reg_params *p)
	74	{
	75	return true;
	76	}
	77
	78	static inline bool read_zero(struct kvm_vcpu *vcpu,
3fec037d	79	struct sys_reg_params *p)
7c8c5e6a	80	{
2ec5be3d	81	p->regval = 0;
7c8c5e6a MZ	82	return true;
	83	}
	84
7c8c5e6a MZ	85	/* Reset functions */
	86	static inline void reset_unknown(struct kvm_vcpu *vcpu,
	87	const struct sys_reg_desc *r)
	88	{
	89	BUG_ON(!r->reg);
	90	BUG_ON(r->reg >= NR_SYS_REGS);
8d404c4c	91	__vcpu_sys_reg(vcpu, r->reg) = 0x1de7ec7edbadc0deULL;
7c8c5e6a MZ	92	}
	93
	94	static inline void reset_val(struct kvm_vcpu vcpu, const struct sys_reg_desc r)
	95	{
	96	BUG_ON(!r->reg);
	97	BUG_ON(r->reg >= NR_SYS_REGS);
8d404c4c	98	__vcpu_sys_reg(vcpu, r->reg) = r->val;
7c8c5e6a MZ	99	}
7c8c5e6a MZ	100
7f34e409 DM	101	static inline bool sysreg_hidden_from_guest(const struct kvm_vcpu *vcpu,
	102	const struct sys_reg_desc *r)
	103	{
	104	if (likely(!r->visibility))
	105	return false;
	106
	107	return r->visibility(vcpu, r) & REG_HIDDEN_GUEST;
	108	}
	109
	110	static inline bool sysreg_hidden_from_user(const struct kvm_vcpu *vcpu,
	111	const struct sys_reg_desc *r)
	112	{
	113	if (likely(!r->visibility))
	114	return false;
	115
	116	return r->visibility(vcpu, r) & REG_HIDDEN_USER;
	117	}
	118
7c8c5e6a MZ	119	static inline int cmp_sys_reg(const struct sys_reg_desc *i1,
	120	const struct sys_reg_desc *i2)
	121	{
	122	BUG_ON(i1 == i2);
	123	if (!i1)
	124	return 1;
	125	else if (!i2)
	126	return -1;
	127	if (i1->Op0 != i2->Op0)
	128	return i1->Op0 - i2->Op0;
	129	if (i1->Op1 != i2->Op1)
	130	return i1->Op1 - i2->Op1;
	131	if (i1->CRn != i2->CRn)
	132	return i1->CRn - i2->CRn;
	133	if (i1->CRm != i2->CRm)
	134	return i1->CRm - i2->CRm;
	135	return i1->Op2 - i2->Op2;
	136	}
	137
4b927b94 VK	138	const struct sys_reg_desc *find_reg_by_id(u64 id,
	139	struct sys_reg_params *params,
	140	const struct sys_reg_desc table[],
	141	unsigned int num);
7c8c5e6a MZ	142
	143	#define Op0(_x) .Op0 = _x
	144	#define Op1(_x) .Op1 = _x
	145	#define CRn(_x) .CRn = _x
	146	#define CRm(_x) .CRm = _x
	147	#define Op2(_x) .Op2 = _x
	148
8db5d8f1	149	#define SYS_DESC(reg) \
599d79dc	150	.name = #reg, \
8db5d8f1 MR	151	Op0(sys_reg_Op0(reg)), Op1(sys_reg_Op1(reg)), \
	152	CRn(sys_reg_CRn(reg)), CRm(sys_reg_CRm(reg)), \
	153	Op2(sys_reg_Op2(reg))
	154
7c8c5e6a	155	#endif /* __ARM64_KVM_SYS_REGS_LOCAL_H__ */