bfd/ChangeLog
[external/binutils.git] / include / elf / xtensa.h
1 /* Xtensa ELF support for BFD.
2    Copyright (C) 2003-2014 Free Software Foundation, Inc.
3    Contributed by Bob Wilson (bwilson@tensilica.com) at Tensilica.
4
5    This file is part of BFD, the Binary File Descriptor library.
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, write to the Free Software
19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301,
20    USA.  */
21
22 /* This file holds definitions specific to the Xtensa ELF ABI.  */
23
24 #ifndef _ELF_XTENSA_H
25 #define _ELF_XTENSA_H
26
27 #include "elf/reloc-macros.h"
28
29 /* Relocations.  */
30 START_RELOC_NUMBERS (elf_xtensa_reloc_type)
31      RELOC_NUMBER (R_XTENSA_NONE, 0)
32      RELOC_NUMBER (R_XTENSA_32, 1)
33      RELOC_NUMBER (R_XTENSA_RTLD, 2)
34      RELOC_NUMBER (R_XTENSA_GLOB_DAT, 3)
35      RELOC_NUMBER (R_XTENSA_JMP_SLOT, 4)
36      RELOC_NUMBER (R_XTENSA_RELATIVE, 5)
37      RELOC_NUMBER (R_XTENSA_PLT, 6)
38      RELOC_NUMBER (R_XTENSA_OP0, 8)
39      RELOC_NUMBER (R_XTENSA_OP1, 9)
40      RELOC_NUMBER (R_XTENSA_OP2, 10) 
41      RELOC_NUMBER (R_XTENSA_ASM_EXPAND, 11)
42      RELOC_NUMBER (R_XTENSA_ASM_SIMPLIFY, 12)
43      RELOC_NUMBER (R_XTENSA_32_PCREL, 14)
44      RELOC_NUMBER (R_XTENSA_GNU_VTINHERIT, 15)
45      RELOC_NUMBER (R_XTENSA_GNU_VTENTRY, 16)
46      RELOC_NUMBER (R_XTENSA_DIFF8, 17)
47      RELOC_NUMBER (R_XTENSA_DIFF16, 18)
48      RELOC_NUMBER (R_XTENSA_DIFF32, 19)
49      RELOC_NUMBER (R_XTENSA_SLOT0_OP, 20)
50      RELOC_NUMBER (R_XTENSA_SLOT1_OP, 21)
51      RELOC_NUMBER (R_XTENSA_SLOT2_OP, 22)
52      RELOC_NUMBER (R_XTENSA_SLOT3_OP, 23)
53      RELOC_NUMBER (R_XTENSA_SLOT4_OP, 24)
54      RELOC_NUMBER (R_XTENSA_SLOT5_OP, 25)
55      RELOC_NUMBER (R_XTENSA_SLOT6_OP, 26)
56      RELOC_NUMBER (R_XTENSA_SLOT7_OP, 27)
57      RELOC_NUMBER (R_XTENSA_SLOT8_OP, 28)
58      RELOC_NUMBER (R_XTENSA_SLOT9_OP, 29)
59      RELOC_NUMBER (R_XTENSA_SLOT10_OP, 30)
60      RELOC_NUMBER (R_XTENSA_SLOT11_OP, 31)
61      RELOC_NUMBER (R_XTENSA_SLOT12_OP, 32)
62      RELOC_NUMBER (R_XTENSA_SLOT13_OP, 33)
63      RELOC_NUMBER (R_XTENSA_SLOT14_OP, 34)
64      RELOC_NUMBER (R_XTENSA_SLOT0_ALT, 35)
65      RELOC_NUMBER (R_XTENSA_SLOT1_ALT, 36)
66      RELOC_NUMBER (R_XTENSA_SLOT2_ALT, 37)
67      RELOC_NUMBER (R_XTENSA_SLOT3_ALT, 38)
68      RELOC_NUMBER (R_XTENSA_SLOT4_ALT, 39)
69      RELOC_NUMBER (R_XTENSA_SLOT5_ALT, 40)
70      RELOC_NUMBER (R_XTENSA_SLOT6_ALT, 41)
71      RELOC_NUMBER (R_XTENSA_SLOT7_ALT, 42)
72      RELOC_NUMBER (R_XTENSA_SLOT8_ALT, 43)
73      RELOC_NUMBER (R_XTENSA_SLOT9_ALT, 44)
74      RELOC_NUMBER (R_XTENSA_SLOT10_ALT, 45)
75      RELOC_NUMBER (R_XTENSA_SLOT11_ALT, 46)
76      RELOC_NUMBER (R_XTENSA_SLOT12_ALT, 47)
77      RELOC_NUMBER (R_XTENSA_SLOT13_ALT, 48)
78      RELOC_NUMBER (R_XTENSA_SLOT14_ALT, 49)
79      RELOC_NUMBER (R_XTENSA_TLSDESC_FN, 50)
80      RELOC_NUMBER (R_XTENSA_TLSDESC_ARG, 51)
81      RELOC_NUMBER (R_XTENSA_TLS_DTPOFF, 52)
82      RELOC_NUMBER (R_XTENSA_TLS_TPOFF, 53)
83      RELOC_NUMBER (R_XTENSA_TLS_FUNC, 54)
84      RELOC_NUMBER (R_XTENSA_TLS_ARG, 55)
85      RELOC_NUMBER (R_XTENSA_TLS_CALL, 56)
86 END_RELOC_NUMBERS (R_XTENSA_max)
87
88 /* Processor-specific flags for the ELF header e_flags field.  */
89
90 /* Four-bit Xtensa machine type field.  */
91 #define EF_XTENSA_MACH                  0x0000000f
92
93 /* Various CPU types.  */
94 #define E_XTENSA_MACH                   0x00000000
95
96 /* Leave bits 0xf0 alone in case we ever have more than 16 cpu types.
97    Highly unlikely, but what the heck.  */
98
99 #define EF_XTENSA_XT_INSN               0x00000100
100 #define EF_XTENSA_XT_LIT                0x00000200
101
102
103 /* Processor-specific dynamic array tags.  */
104
105 /* Offset of the table that records the GOT location(s).  */
106 #define DT_XTENSA_GOT_LOC_OFF           0x70000000
107
108 /* Number of entries in the GOT location table.  */
109 #define DT_XTENSA_GOT_LOC_SZ            0x70000001
110
111
112 /* Definitions for instruction and literal property tables.  The
113    tables for ".gnu.linkonce.*" sections are placed in the following
114    sections:
115
116    instruction tables:  .gnu.linkonce.x.*
117    literal tables:      .gnu.linkonce.p.*
118 */
119
120 #define XTENSA_INSN_SEC_NAME ".xt.insn"
121 #define XTENSA_LIT_SEC_NAME  ".xt.lit"
122 #define XTENSA_PROP_SEC_NAME ".xt.prop"
123
124 typedef struct property_table_entry_t
125 {
126   bfd_vma address;
127   bfd_vma size;
128   flagword flags;
129 } property_table_entry;
130
131 /* Flags in the property tables to specify whether blocks of memory are
132    literals, instructions, data, or unreachable.  For instructions,
133    blocks that begin loop targets and branch targets are designated.
134    Blocks that do not allow density instructions, instruction reordering
135    or transformation are also specified.  Finally, for branch targets,
136    branch target alignment priority is included.  Alignment of the next
137    block is specified in the current block and the size of the current
138    block does not include any fill required to align to the next
139    block.  */
140    
141 #define XTENSA_PROP_LITERAL             0x00000001
142 #define XTENSA_PROP_INSN                0x00000002
143 #define XTENSA_PROP_DATA                0x00000004
144 #define XTENSA_PROP_UNREACHABLE         0x00000008
145 /* Instruction-only properties at beginning of code. */
146 #define XTENSA_PROP_INSN_LOOP_TARGET    0x00000010
147 #define XTENSA_PROP_INSN_BRANCH_TARGET  0x00000020
148 /* Instruction-only properties about code. */
149 #define XTENSA_PROP_INSN_NO_DENSITY     0x00000040
150 #define XTENSA_PROP_INSN_NO_REORDER     0x00000080
151 /* Historically, NO_TRANSFORM was a property of instructions, 
152    but it should apply to literals under certain circumstances.  */
153 #define XTENSA_PROP_NO_TRANSFORM        0x00000100
154
155 /*  Branch target alignment information.  This transmits information
156     to the linker optimization about the priority of aligning a
157     particular block for branch target alignment: None, low priority,
158     high priority, or required.  These only need to be checked in
159     instruction blocks marked as XTENSA_PROP_INSN_BRANCH_TARGET.
160     Common usage is:
161
162     switch (GET_XTENSA_PROP_BT_ALIGN(flags))
163     case XTENSA_PROP_BT_ALIGN_NONE:
164     case XTENSA_PROP_BT_ALIGN_LOW:
165     case XTENSA_PROP_BT_ALIGN_HIGH:
166     case XTENSA_PROP_BT_ALIGN_REQUIRE:
167 */
168 #define XTENSA_PROP_BT_ALIGN_MASK       0x00000600
169
170 /* No branch target alignment.  */
171 #define XTENSA_PROP_BT_ALIGN_NONE       0x0
172 /* Low priority branch target alignment.  */
173 #define XTENSA_PROP_BT_ALIGN_LOW        0x1
174 /* High priority branch target alignment. */
175 #define XTENSA_PROP_BT_ALIGN_HIGH       0x2
176 /* Required branch target alignment.  */
177 #define XTENSA_PROP_BT_ALIGN_REQUIRE    0x3
178
179 #define GET_XTENSA_PROP_BT_ALIGN(flag) \
180   (((unsigned)((flag) & (XTENSA_PROP_BT_ALIGN_MASK))) >> 9)
181 #define SET_XTENSA_PROP_BT_ALIGN(flag, align) \
182   (((flag) & (~XTENSA_PROP_BT_ALIGN_MASK)) | \
183     (((align) << 9) & XTENSA_PROP_BT_ALIGN_MASK))
184
185 /* Alignment is specified in the block BEFORE the one that needs
186    alignment.  Up to 5 bits.  Use GET_XTENSA_PROP_ALIGNMENT(flags) to
187    get the required alignment specified as a power of 2.  Use
188    SET_XTENSA_PROP_ALIGNMENT(flags, pow2) to set the required
189    alignment.  Be careful of side effects since the SET will evaluate
190    flags twice.  Also, note that the SIZE of a block in the property
191    table does not include the alignment size, so the alignment fill
192    must be calculated to determine if two blocks are contiguous.
193    TEXT_ALIGN is not currently implemented but is a placeholder for a
194    possible future implementation.  */
195
196 #define XTENSA_PROP_ALIGN               0x00000800
197
198 #define XTENSA_PROP_ALIGNMENT_MASK      0x0001f000
199
200 #define GET_XTENSA_PROP_ALIGNMENT(flag) \
201   (((unsigned)((flag) & (XTENSA_PROP_ALIGNMENT_MASK))) >> 12)
202 #define SET_XTENSA_PROP_ALIGNMENT(flag, align) \
203   (((flag) & (~XTENSA_PROP_ALIGNMENT_MASK)) | \
204     (((align) << 12) & XTENSA_PROP_ALIGNMENT_MASK))
205
206 #define XTENSA_PROP_INSN_ABSLIT        0x00020000
207
208 #endif /* _ELF_XTENSA_H */