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
49typedef 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
56typedef 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#define	ELF_ARCH	EM_AARCH64
68
69#define	ELF_MACHINE_OK(x) ((x) == (ELF_ARCH))
70
71/* Values for a_type. */
72#define	AT_NULL		0	/* Terminates the vector. */
73#define	AT_IGNORE	1	/* Ignored entry. */
74#define	AT_EXECFD	2	/* File descriptor of program to load. */
75#define	AT_PHDR		3	/* Program header of program already loaded. */
76#define	AT_PHENT	4	/* Size of each program header entry. */
77#define	AT_PHNUM	5	/* Number of program header entries. */
78#define	AT_PAGESZ	6	/* Page size in bytes. */
79#define	AT_BASE		7	/* Interpreter's base address. */
80#define	AT_FLAGS	8	/* Flags (unused). */
81#define	AT_ENTRY	9	/* Where interpreter should transfer control. */
82#define	AT_NOTELF	10	/* Program is not ELF ?? */
83#define	AT_UID		11	/* Real uid. */
84#define	AT_EUID		12	/* Effective uid. */
85#define	AT_GID		13	/* Real gid. */
86#define	AT_EGID		14	/* Effective gid. */
87#define	AT_EXECPATH	15	/* Path to the executable. */
88#define	AT_CANARY	16	/* Canary for SSP */
89#define	AT_CANARYLEN	17	/* Length of the canary. */
90#define	AT_OSRELDATE	18	/* OSRELDATE. */
91#define	AT_NCPUS	19	/* Number of CPUs. */
92#define	AT_PAGESIZES	20	/* Pagesizes. */
93#define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
94#define	AT_TIMEKEEP	22	/* Pointer to timehands. */
95#define	AT_STACKPROT	23	/* Initial stack protection. */
96#define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
97#define	AT_HWCAP	25	/* CPU feature flags. */
98#define	AT_HWCAP2	26	/* CPU feature flags 2. */
99
100#define	AT_COUNT	27	/* Count of defined aux entry types. */
101
102/* Define "machine" characteristics */
103#if __ELF_WORD_SIZE == 64
104#define	ELF_TARG_CLASS	ELFCLASS64
105#define	ELF_TARG_DATA	ELFDATA2LSB
106#define	ELF_TARG_MACH	EM_AARCH64
107#define	ELF_TARG_VER	1
108#else
109#define	ELF_TARG_CLASS	ELFCLASS32
110#define	ELF_TARG_DATA	ELFDATA2LSB
111#define	ELF_TARG_MACH	EM_ARM
112#define	ELF_TARG_VER	1
113#endif
114
115#define	ET_DYN_LOAD_ADDR 0x100000
116
117/* HWCAP */
118#define	HWCAP_FP		0x00000001
119#define	HWCAP_ASIMD		0x00000002
120#define	HWCAP_EVTSTRM		0x00000004
121#define	HWCAP_AES		0x00000008
122#define	HWCAP_PMULL		0x00000010
123#define	HWCAP_SHA1		0x00000020
124#define	HWCAP_SHA2		0x00000040
125#define	HWCAP_CRC32		0x00000080
126#define	HWCAP_ATOMICS		0x00000100
127#define	HWCAP_FPHP		0x00000200
128#define	HWCAP_ASIMDHP		0x00000400
129/*
130 * XXX: The following bits (from CPUID to FLAGM) were originally incorrect,
131 * but later changed to match the Linux definitions. No compatibility code is
132 * provided, as the fix was expected to result in near-zero fallout.
133 */
134#define	HWCAP_CPUID		0x00000800
135#define	HWCAP_ASIMDRDM		0x00001000
136#define	HWCAP_JSCVT		0x00002000
137#define	HWCAP_FCMA		0x00004000
138#define	HWCAP_LRCPC		0x00008000
139#define	HWCAP_DCPOP		0x00010000
140#define	HWCAP_SHA3		0x00020000
141#define	HWCAP_SM3		0x00040000
142#define	HWCAP_SM4		0x00080000
143#define	HWCAP_ASIMDDP		0x00100000
144#define	HWCAP_SHA512		0x00200000
145#define	HWCAP_SVE		0x00400000
146#define	HWCAP_ASIMDFHM		0x00800000
147#define	HWCAP_DIT		0x01000000
148#define	HWCAP_USCAT		0x02000000
149#define	HWCAP_ILRCPC		0x04000000
150#define	HWCAP_FLAGM		0x08000000
151#define	HWCAP_SSBS		0x10000000
152#define	HWCAP_SB		0x20000000
153#define	HWCAP_PACA		0x40000000
154#define	HWCAP_PACG		0x80000000
155
156/* HWCAP2 */
157#define	HWCAP2_DCPODP		0x00000001
158#define	HWCAP2_SVE2		0x00000002
159#define	HWCAP2_SVEAES		0x00000004
160#define	HWCAP2_SVEPMULL		0x00000008
161#define	HWCAP2_SVEBITPERM	0x00000010
162#define	HWCAP2_SVESHA3		0x00000020
163#define	HWCAP2_SVESM4		0x00000040
164#define	HWCAP2_FLAGM2		0x00000080
165#define	HWCAP2_FRINT		0x00000100
166#define	HWCAP2_SVEI8MM		0x00000200
167#define	HWCAP2_SVEF32MM		0x00000400
168#define	HWCAP2_SVEF64MM		0x00000800
169#define	HWCAP2_SVEBF16		0x00001000
170#define	HWCAP2_I8MM		0x00002000
171#define	HWCAP2_BF16		0x00004000
172#define	HWCAP2_DGH		0x00008000
173#define	HWCAP2_RNG		0x00010000
174#define	HWCAP2_BTI		0x00020000
175
176#endif /* !_MACHINE_ELF_H_ */
177