xref: /freebsd/sys/arm64/include/elf.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
1 /*-
2  * Copyright (c) 1996-1997 John D. Polstra.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef	_MACHINE_ELF_H_
30 #define	_MACHINE_ELF_H_
31 
32 /*
33  * ELF definitions for the AArch64 architecture.
34  */
35 
36 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
37 #include <sys/elf64.h>	/* Definitions common to all 64 bit architectures. */
38 
39 #ifndef __ELF_WORD_SIZE
40 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
41 #endif
42 
43 #include <sys/elf_generic.h>
44 
45 /*
46  * Auxiliary vector entries for passing information to the interpreter.
47  */
48 
49 typedef struct {	/* Auxiliary vector entry on initial stack */
50 	int	a_type;			/* Entry type. */
51 	union {
52 		int	a_val;		/* Integer value. */
53 	} a_un;
54 } Elf32_Auxinfo;
55 
56 typedef struct {	/* Auxiliary vector entry on initial stack */
57 	long	a_type;			/* Entry type. */
58 	union {
59 		long	a_val;		/* Integer value. */
60 		void	*a_ptr;		/* Address. */
61 		void	(*a_fcn)(void);	/* Function pointer (not used). */
62 	} a_un;
63 } Elf64_Auxinfo;
64 
65 __ElfType(Auxinfo);
66 
67 #ifdef _MACHINE_ELF_WANT_32BIT
68 #define	ELF_ARCH	EM_ARM
69 #else
70 #define	ELF_ARCH	EM_AARCH64
71 #endif
72 
73 #define	ELF_MACHINE_OK(x) ((x) == (ELF_ARCH))
74 
75 /* Define "machine" characteristics */
76 #if __ELF_WORD_SIZE == 64
77 #define	ELF_TARG_CLASS	ELFCLASS64
78 #define	ELF_TARG_DATA	ELFDATA2LSB
79 #define	ELF_TARG_MACH	EM_AARCH64
80 #define	ELF_TARG_VER	1
81 #else
82 #define	ELF_TARG_CLASS	ELFCLASS32
83 #define	ELF_TARG_DATA	ELFDATA2LSB
84 #define	ELF_TARG_MACH	EM_ARM
85 #define	ELF_TARG_VER	1
86 #endif
87 
88 #if __ELF_WORD_SIZE == 32
89 #define	ET_DYN_LOAD_ADDR 0x12000
90 #else
91 #define	ET_DYN_LOAD_ADDR 0x100000
92 #endif
93 
94 /* HWCAP */
95 #define	HWCAP_FP		0x00000001
96 #define	HWCAP_ASIMD		0x00000002
97 #define	HWCAP_EVTSTRM		0x00000004
98 #define	HWCAP_AES		0x00000008
99 #define	HWCAP_PMULL		0x00000010
100 #define	HWCAP_SHA1		0x00000020
101 #define	HWCAP_SHA2		0x00000040
102 #define	HWCAP_CRC32		0x00000080
103 #define	HWCAP_ATOMICS		0x00000100
104 #define	HWCAP_FPHP		0x00000200
105 #define	HWCAP_ASIMDHP		0x00000400
106 /*
107  * XXX: The following bits (from CPUID to FLAGM) were originally incorrect,
108  * but later changed to match the Linux definitions. No compatibility code is
109  * provided, as the fix was expected to result in near-zero fallout.
110  */
111 #define	HWCAP_CPUID		0x00000800
112 #define	HWCAP_ASIMDRDM		0x00001000
113 #define	HWCAP_JSCVT		0x00002000
114 #define	HWCAP_FCMA		0x00004000
115 #define	HWCAP_LRCPC		0x00008000
116 #define	HWCAP_DCPOP		0x00010000
117 #define	HWCAP_SHA3		0x00020000
118 #define	HWCAP_SM3		0x00040000
119 #define	HWCAP_SM4		0x00080000
120 #define	HWCAP_ASIMDDP		0x00100000
121 #define	HWCAP_SHA512		0x00200000
122 #define	HWCAP_SVE		0x00400000
123 #define	HWCAP_ASIMDFHM		0x00800000
124 #define	HWCAP_DIT		0x01000000
125 #define	HWCAP_USCAT		0x02000000
126 #define	HWCAP_ILRCPC		0x04000000
127 #define	HWCAP_FLAGM		0x08000000
128 #define	HWCAP_SSBS		0x10000000
129 #define	HWCAP_SB		0x20000000
130 #define	HWCAP_PACA		0x40000000
131 #define	HWCAP_PACG		0x80000000
132 
133 /* HWCAP2 */
134 #define	HWCAP2_DCPODP		0x00000001
135 #define	HWCAP2_SVE2		0x00000002
136 #define	HWCAP2_SVEAES		0x00000004
137 #define	HWCAP2_SVEPMULL		0x00000008
138 #define	HWCAP2_SVEBITPERM	0x00000010
139 #define	HWCAP2_SVESHA3		0x00000020
140 #define	HWCAP2_SVESM4		0x00000040
141 #define	HWCAP2_FLAGM2		0x00000080
142 #define	HWCAP2_FRINT		0x00000100
143 #define	HWCAP2_SVEI8MM		0x00000200
144 #define	HWCAP2_SVEF32MM		0x00000400
145 #define	HWCAP2_SVEF64MM		0x00000800
146 #define	HWCAP2_SVEBF16		0x00001000
147 #define	HWCAP2_I8MM		0x00002000
148 #define	HWCAP2_BF16		0x00004000
149 #define	HWCAP2_DGH		0x00008000
150 #define	HWCAP2_RNG		0x00010000
151 #define	HWCAP2_BTI		0x00020000
152 
153 #ifdef COMPAT_FREEBSD32
154 /* ARM HWCAP */
155 #define	HWCAP32_HALF		0x00000002	/* Always set.               */
156 #define	HWCAP32_THUMB		0x00000004	/* Always set.               */
157 #define	HWCAP32_FAST_MULT	0x00000010	/* Always set.               */
158 #define	HWCAP32_VFP		0x00000040
159 #define	HWCAP32_EDSP		0x00000080	/* Always set.               */
160 #define	HWCAP32_NEON		0x00001000
161 #define	HWCAP32_VFPv3		0x00002000
162 #define	HWCAP32_TLS		0x00008000	/* Always set.               */
163 #define	HWCAP32_VFPv4		0x00010000
164 #define	HWCAP32_IDIVA		0x00020000	/* Always set.               */
165 #define	HWCAP32_IDIVT		0x00040000	/* Always set.               */
166 #define	HWCAP32_VFPD32		0x00080000	/* Always set.               */
167 #define	HWCAP32_LPAE		0x00100000	/* Always set.               */
168 
169 #define HWCAP32_DEFAULT \
170    (HWCAP32_HALF | HWCAP32_THUMB | HWCAP32_FAST_MULT | HWCAP32_EDSP |\
171     HWCAP32_TLS | HWCAP32_IDIVA | HWCAP32_IDIVT | HWCAP32_VFPD32 |   \
172     HWCAP32_LPAE)
173 
174 /* ARM HWCAP2 */
175 #define	HWCAP32_2_AES		0x00000001
176 #define	HWCAP32_2_PMULL		0x00000002
177 #define	HWCAP32_2_SHA1		0x00000004
178 #define	HWCAP32_2_SHA2		0x00000008
179 #define	HWCAP32_2_CRC32		0x00000010
180 #endif
181 
182 #endif /* !_MACHINE_ELF_H_ */
183