1 /* Common target-dependent functionality for AArch64.
2 
3    Copyright (C) 2017-2021 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef ARCH_AARCH64_H
21 #define ARCH_AARCH64_H
22 
23 #include "gdbsupport/tdesc.h"
24 
25 /* Create the aarch64 target description.  A non zero VQ value indicates both
26    the presence of SVE and the Vector Quotient - the number of 128bit chunks in
27    an SVE Z register.  HAS_PAUTH_P indicates the presence of the PAUTH
28    feature.
29 
30    MTE_P indicates the presence of the Memory Tagging Extension feature.  */
31 
32 target_desc *aarch64_create_target_description (uint64_t vq, bool has_pauth_p,
33 						bool mte_p);
34 
35 /* Register numbers of various important registers.
36    Note that on SVE, the Z registers reuse the V register numbers and the V
37    registers become pseudo registers.  */
38 enum aarch64_regnum
39 {
40   AARCH64_X0_REGNUM,		/* First integer register.  */
41   AARCH64_FP_REGNUM = AARCH64_X0_REGNUM + 29,	/* Frame register, if used.  */
42   AARCH64_LR_REGNUM = AARCH64_X0_REGNUM + 30,	/* Return address.  */
43   AARCH64_SP_REGNUM,		/* Stack pointer.  */
44   AARCH64_PC_REGNUM,		/* Program counter.  */
45   AARCH64_CPSR_REGNUM,		/* Current Program Status Register.  */
46   AARCH64_V0_REGNUM,		/* First fp/vec register.  */
47   AARCH64_V31_REGNUM = AARCH64_V0_REGNUM + 31,	/* Last fp/vec register.  */
48   AARCH64_SVE_Z0_REGNUM = AARCH64_V0_REGNUM,	/* First SVE Z register.  */
49   AARCH64_SVE_Z31_REGNUM = AARCH64_V31_REGNUM,  /* Last SVE Z register.  */
50   AARCH64_FPSR_REGNUM,		/* Floating Point Status Register.  */
51   AARCH64_FPCR_REGNUM,		/* Floating Point Control Register.  */
52   AARCH64_SVE_P0_REGNUM,	/* First SVE predicate register.  */
53   AARCH64_SVE_P15_REGNUM = AARCH64_SVE_P0_REGNUM + 15,	/* Last SVE predicate
54 							   register.  */
55   AARCH64_SVE_FFR_REGNUM,	/* SVE First Fault Register.  */
56   AARCH64_SVE_VG_REGNUM,	/* SVE Vector Granule.  */
57 
58   /* Other useful registers.  */
59   AARCH64_LAST_X_ARG_REGNUM = AARCH64_X0_REGNUM + 7,
60   AARCH64_STRUCT_RETURN_REGNUM = AARCH64_X0_REGNUM + 8,
61   AARCH64_LAST_V_ARG_REGNUM = AARCH64_V0_REGNUM + 7
62 };
63 
64 #define V_REGISTER_SIZE 16
65 
66 /* Pseudo register base numbers.  */
67 #define AARCH64_Q0_REGNUM 0
68 #define AARCH64_D0_REGNUM (AARCH64_Q0_REGNUM + AARCH64_D_REGISTER_COUNT)
69 #define AARCH64_S0_REGNUM (AARCH64_D0_REGNUM + 32)
70 #define AARCH64_H0_REGNUM (AARCH64_S0_REGNUM + 32)
71 #define AARCH64_B0_REGNUM (AARCH64_H0_REGNUM + 32)
72 #define AARCH64_SVE_V0_REGNUM (AARCH64_B0_REGNUM + 32)
73 
74 #define AARCH64_PAUTH_DMASK_REGNUM(pauth_reg_base) (pauth_reg_base)
75 #define AARCH64_PAUTH_CMASK_REGNUM(pauth_reg_base) (pauth_reg_base + 1)
76 #define AARCH64_PAUTH_REGS_SIZE (16)
77 
78 #define AARCH64_X_REGS_NUM 31
79 #define AARCH64_V_REGS_NUM 32
80 #define AARCH64_SVE_Z_REGS_NUM AARCH64_V_REGS_NUM
81 #define AARCH64_SVE_P_REGS_NUM 16
82 #define AARCH64_NUM_REGS AARCH64_FPCR_REGNUM + 1
83 #define AARCH64_SVE_NUM_REGS AARCH64_SVE_VG_REGNUM + 1
84 
85 
86 /* There are a number of ways of expressing the current SVE vector size:
87 
88    VL : Vector Length.
89 	The number of bytes in an SVE Z register.
90    VQ : Vector Quotient.
91 	The number of 128bit chunks in an SVE Z register.
92    VG : Vector Granule.
93 	The number of 64bit chunks in an SVE Z register.  */
94 
95 #define sve_vg_from_vl(vl)	((vl) / 8)
96 #define sve_vl_from_vg(vg)	((vg) * 8)
97 #ifndef sve_vq_from_vl
98 #define sve_vq_from_vl(vl)	((vl) / 0x10)
99 #endif
100 #ifndef sve_vl_from_vq
101 #define sve_vl_from_vq(vq)	((vq) * 0x10)
102 #endif
103 #define sve_vq_from_vg(vg)	(sve_vq_from_vl (sve_vl_from_vg (vg)))
104 #define sve_vg_from_vq(vq)	(sve_vg_from_vl (sve_vl_from_vq (vq)))
105 
106 
107 /* Maximum supported VQ value.  Increase if required.  */
108 #define AARCH64_MAX_SVE_VQ  16
109 
110 #endif /* ARCH_AARCH64_H */
111