xref: /freebsd/sys/arm/include/elf.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2001 David E. O'Brien
5  * Copyright (c) 1996-1997 John D. Polstra.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _MACHINE_ELF_H_
33 #define	_MACHINE_ELF_H_ 1
34 
35 /*
36  * EABI ELF definitions for the StrongARM architecture.
37  * See "ARM ELF", document no. `SWS ESPC 0003 A-08' for details.
38  */
39 
40 #include <sys/elf32.h>	/* Definitions common to all 32 bit architectures. */
41 
42 #define	__ELF_WORD_SIZE	32	/* Used by <sys/elf_generic.h> */
43 #include <sys/elf_generic.h>
44 
45 typedef struct {        /* Auxiliary vector entry on initial stack */
46 	int     a_type;                 /* Entry type. */
47 	union {
48 		long    a_val;          /* Integer value. */
49 		void    *a_ptr;         /* Address. */
50 		void    (*a_fcn)(void); /* Function pointer (not used). */
51 	} a_un;
52 } Elf32_Auxinfo;
53 
54 __ElfType(Auxinfo);
55 
56 #define	ELF_ARCH	EM_ARM
57 
58 #define	ELF_MACHINE_OK(x) ((x) == EM_ARM)
59 
60 /*
61  * Relocation types.
62  */
63 
64 /* Values for a_type. */
65 #define	AT_NULL		0	/* Terminates the vector. */
66 #define	AT_IGNORE	1	/* Ignored entry. */
67 #define	AT_EXECFD	2	/* File descriptor of program to load. */
68 #define	AT_PHDR		3	/* Program header of program already loaded. */
69 #define	AT_PHENT	4	/* Size of each program header entry. */
70 #define	AT_PHNUM	5	/* Number of program header entries. */
71 #define	AT_PAGESZ	6	/* Page size in bytes. */
72 #define	AT_BASE		7	/* Interpreter's base address. */
73 #define	AT_FLAGS	8	/* Flags (unused). */
74 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
75 #define	AT_NOTELF	10	/* Program is not ELF ?? */
76 #define	AT_UID		11	/* Real uid. */
77 #define	AT_EUID		12	/* Effective uid. */
78 #define	AT_GID		13	/* Real gid. */
79 #define	AT_EGID		14	/* Effective gid. */
80 #define	AT_EXECPATH	15	/* Path to the executable. */
81 #define	AT_CANARY	16	/* Canary for SSP */
82 #define	AT_CANARYLEN	17	/* Length of the canary. */
83 #define	AT_OSRELDATE	18	/* OSRELDATE. */
84 #define	AT_NCPUS	19	/* Number of CPUs. */
85 #define	AT_PAGESIZES	20	/* Pagesizes. */
86 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
87 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
88 #define	AT_STACKPROT	23	/* Initial stack protection. */
89 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
90 #define	AT_HWCAP	25	/* CPU feature flags. */
91 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
92 
93 #define	AT_COUNT	27	/* Count of defined aux entry types. */
94 
95 #define	R_ARM_COUNT	33	/* Count of defined relocation types. */
96 
97 
98 /* Define "machine" characteristics */
99 #define	ELF_TARG_CLASS	ELFCLASS32
100 #ifdef __ARMEB__
101 #define	ELF_TARG_DATA	ELFDATA2MSB
102 #else
103 #define	ELF_TARG_DATA	ELFDATA2LSB
104 #endif
105 #define	ELF_TARG_MACH	EM_ARM
106 #define	ELF_TARG_VER	1
107 
108 /* Defines specific for arm headers */
109 #define	EF_ARM_EABI_VERSION(x) (((x) & EF_ARM_EABIMASK) >> 24)
110 #define	EF_ARM_EABI_VERSION_UNKNOWN 0
111 #define	EF_ARM_EABI_FREEBSD_MIN 4
112 
113 /*
114  * Magic number for the elf trampoline, chosen wisely to be an immediate
115  * value.
116  */
117 #define	MAGIC_TRAMP_NUMBER	0x5c000003
118 
119 #define	ET_DYN_LOAD_ADDR	0x12000
120 
121 /* Flags passed in AT_HWCAP. */
122 #define	HWCAP_SWP		0x00000001	/* Unsupported, never set.    */
123 #define	HWCAP_HALF		0x00000002	/* Always set.                */
124 #define	HWCAP_THUMB		0x00000004
125 #define	HWCAP_26BIT		0x00000008	/* Unsupported, never set.    */
126 #define	HWCAP_FAST_MULT		0x00000010	/* Always set.                */
127 #define	HWCAP_FPA		0x00000020	/* Unsupported, never set.    */
128 #define	HWCAP_VFP		0x00000040
129 #define	HWCAP_EDSP		0x00000080	/* Always set for ARMv6+.     */
130 #define	HWCAP_JAVA		0x00000100	/* Unsupported, never set.    */
131 #define	HWCAP_IWMMXT		0x00000200	/* Unsupported, never set.    */
132 #define	HWCAP_CRUNCH		0x00000400	/* Unsupported, never set.    */
133 #define	HWCAP_THUMBEE		0x00000800
134 #define	HWCAP_NEON		0x00001000
135 #define	HWCAP_VFPv3		0x00002000
136 #define	HWCAP_VFPv3D16		0x00004000
137 #define	HWCAP_TLS		0x00008000	/* Always set for ARMv6+.     */
138 #define	HWCAP_VFPv4		0x00010000
139 #define	HWCAP_IDIVA		0x00020000
140 #define	HWCAP_IDIVT		0x00040000
141 #define	HWCAP_VFPD32		0x00080000
142 #define	HWCAP_IDIV		(HWCAP_IDIVA | HWCAP_IDIVT)
143 #define	HWCAP_LPAE		0x00100000
144 #define	HWCAP_EVTSTRM		0x00200000	/* Not implemented yet.       */
145 
146 
147 /* Flags passed in AT_HWCAP2. */
148 #define	HWCAP2_AES		0x00000001
149 #define	HWCAP2_PMULL		0x00000002
150 #define	HWCAP2_SHA1		0x00000004
151 #define	HWCAP2_SHA2		0x00000008
152 #define	HWCAP2_CRC32		0x00000010
153 
154 #endif /* !_MACHINE_ELF_H_ */
155