xref: /freebsd/sys/riscv/include/elf.h (revision f5147e312f43a9050468de539aeafa072caa1a60)
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 RISC-V 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 #define	__ELF_WORD_SIZE	64	/* Used by <sys/elf_generic.h> */
40 #include <sys/elf_generic.h>
41 
42 /*
43  * Auxiliary vector entries for passing information to the interpreter.
44  */
45 
46 typedef struct {	/* Auxiliary vector entry on initial stack */
47 	int	a_type;			/* Entry type. */
48 	union {
49 		int	a_val;		/* Integer value. */
50 	} a_un;
51 } Elf32_Auxinfo;
52 
53 typedef struct {	/* Auxiliary vector entry on initial stack */
54 	long	a_type;			/* Entry type. */
55 	union {
56 		long	a_val;		/* Integer value. */
57 		void	*a_ptr;		/* Address. */
58 		void	(*a_fcn)(void);	/* Function pointer (not used). */
59 	} a_un;
60 } Elf64_Auxinfo;
61 
62 __ElfType(Auxinfo);
63 
64 #define	ELF_ARCH	EM_RISCV
65 
66 #define	ELF_MACHINE_OK(x) ((x) == (ELF_ARCH))
67 
68 /* Values for a_type. */
69 #define	AT_NULL		0	/* Terminates the vector. */
70 #define	AT_IGNORE	1	/* Ignored entry. */
71 #define	AT_EXECFD	2	/* File descriptor of program to load. */
72 #define	AT_PHDR		3	/* Program header of program already loaded. */
73 #define	AT_PHENT	4	/* Size of each program header entry. */
74 #define	AT_PHNUM	5	/* Number of program header entries. */
75 #define	AT_PAGESZ	6	/* Page size in bytes. */
76 #define	AT_BASE		7	/* Interpreter's base address. */
77 #define	AT_FLAGS	8	/* Flags (unused). */
78 #define	AT_ENTRY	9	/* Where interpreter should transfer control. */
79 #define	AT_NOTELF	10	/* Program is not ELF ?? */
80 #define	AT_UID		11	/* Real uid. */
81 #define	AT_EUID		12	/* Effective uid. */
82 #define	AT_GID		13	/* Real gid. */
83 #define	AT_EGID		14	/* Effective gid. */
84 #define	AT_EXECPATH	15	/* Path to the executable. */
85 #define	AT_CANARY	16	/* Canary for SSP */
86 #define	AT_CANARYLEN	17	/* Length of the canary. */
87 #define	AT_OSRELDATE	18	/* OSRELDATE. */
88 #define	AT_NCPUS	19	/* Number of CPUs. */
89 #define	AT_PAGESIZES	20	/* Pagesizes. */
90 #define	AT_PAGESIZESLEN	21	/* Number of pagesizes. */
91 #define	AT_TIMEKEEP	22	/* Pointer to timehands. */
92 #define	AT_STACKPROT	23	/* Initial stack protection. */
93 #define	AT_EHDRFLAGS	24	/* e_flags field from elf hdr */
94 #define	AT_HWCAP	25	/* CPU feature flags. */
95 #define	AT_HWCAP2	26	/* CPU feature flags 2. */
96 
97 #define	AT_COUNT	27	/* Count of defined aux entry types. */
98 
99 /* Define "machine" characteristics */
100 #define	ELF_TARG_CLASS	ELFCLASS64
101 #define	ELF_TARG_DATA	ELFDATA2LSB
102 #define	ELF_TARG_MACH	EM_RISCV
103 #define	ELF_TARG_VER	1
104 
105 /* TODO: set correct value */
106 #define	ET_DYN_LOAD_ADDR 0x100000
107 
108 #endif /* !_MACHINE_ELF_H_ */
109