xref: /netbsd-src/external/gpl3/binutils.old/dist/gas/config/tc-nds32.h (revision e7ac2a8b5bd66fa2e050809de09a075c36a7014d)
1 /* tc-nds32.h -- Header file for tc-nds32.c.
2    Copyright (C) 2012-2018 Free Software Foundation, Inc.
3    Contributed by Andes Technology Corporation.
4 
5    This file is part of GAS.
6 
7    GAS 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, or (at your option)
10    any later version.
11 
12    GAS 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 GAS; see the file COPYING.  If not, write to the Free
19    Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
20    02110-1301, USA.  */
21 
22 #ifndef TC_NDS32
23 #define TC_NDS32
24 
25 #include "bfd_stdint.h"
26 
27 #define LISTING_HEADER \
28   (target_big_endian ? "NDS32 GAS" : "NDS32 GAS Little Endian")
29 
30 /* The target BFD architecture.  */
31 #define TARGET_ARCH		bfd_arch_nds32
32 
33 /* mapping to mach_table[5] */
34 #define ISA_V1      bfd_mach_n1h
35 #define ISA_V2      bfd_mach_n1h_v2
36 #define ISA_V3      bfd_mach_n1h_v3
37 #define ISA_V3M     bfd_mach_n1h_v3m
38 
39 /* Default to big endian. Please note that for Andes architecture,
40    instructions are always in big-endian format.  */
41 #ifndef TARGET_BYTES_BIG_ENDIAN
42 #define TARGET_BYTES_BIG_ENDIAN	1
43 #endif
44 
45 /* as.c.  */
46 /* Extend GAS command line option handling capability.  */
47 extern int nds32_parse_option (int, const char *);
48 extern void nds32_after_parse_args (void);
49 /* The endianness of the target format may change based on command
50    line arguments.  */
51 extern const char * nds32_target_format (void);
52 
53 #define md_parse_option(optc, optarg)	nds32_parse_option (optc, optarg)
54 #define md_after_parse_args()		nds32_after_parse_args ()
55 #define TARGET_FORMAT nds32_target_format()
56 
57 /* expr.c */
58 extern int nds32_parse_name (char const *, expressionS *, enum expr_mode, char *);
59 extern bfd_boolean nds32_allow_local_subtract (expressionS *, expressionS *, segT);
60 #define md_parse_name(name, exprP, mode, nextcharP) \
61 	nds32_parse_name (name, exprP, mode, nextcharP)
62 #define md_allow_local_subtract(lhs,rhs,sect)	nds32_allow_local_subtract (lhs, rhs, sect)
63 
64 /* dwarf2dbg.c.  */
65 #define DWARF2_USE_FIXED_ADVANCE_PC		1
66 
67 /* write.c.  */
68 extern long nds32_pcrel_from_section (struct fix *, segT);
69 extern bfd_boolean nds32_fix_adjustable (struct fix *);
70 extern void nds32_frob_file (void);
71 extern void nds32_post_relax_hook (void);
72 extern void nds32_frob_file_before_fix (void);
73 extern void elf_nds32_final_processing (void);
74 extern int nds32_validate_fix_sub (struct fix *, segT);
75 extern int nds32_force_relocation (struct fix *);
76 extern void nds32_set_section_relocs (asection *, arelent ** , unsigned int);
77 
78 /* Fill in rs_align_code fragments.  TODO: Review this.  */
79 extern void nds32_handle_align (fragS *);
80 extern int nds32_relax_frag (segT, fragS *, long);
81 extern int tc_nds32_regname_to_dw2regnum (char *);
82 extern void tc_nds32_frame_initial_instructions (void);
83 
84 #define MD_PCREL_FROM_SECTION(fix, sect)	nds32_pcrel_from_section (fix, sect)
85 #define TC_FINALIZE_SYMS_BEFORE_SIZE_SEG	0
86 #define tc_fix_adjustable(FIX)			nds32_fix_adjustable (FIX)
87 #define md_apply_fix(fixP, addn, seg)		nds32_apply_fix (fixP, addn, seg)
88 #define md_post_relax_hook			nds32_post_relax_hook ()
89 #define tc_frob_file_before_fix()		nds32_frob_file_before_fix ()
90 #define elf_tc_final_processing()		elf_nds32_final_processing ()
91 /* For DIFF relocations.  The default behavior is inconsistent with the
92    asm internal document.  */
93 #define TC_FORCE_RELOCATION_SUB_SAME(FIX, SEC)		\
94   (GENERIC_FORCE_RELOCATION_SUB_SAME (FIX, SEC)		\
95    || TC_FORCE_RELOCATION (FIX))
96 #define TC_FORCE_RELOCATION(fix)		nds32_force_relocation (fix)
97 #define TC_VALIDATE_FIX_SUB(FIX,SEG)		nds32_validate_fix_sub (FIX,SEG)
98 #define SET_SECTION_RELOCS(sec, relocs, n)	nds32_set_section_relocs (sec, relocs, n)
99 /* Values passed to md_apply_fix don't include the symbol value.  */
100 #define MD_APPLY_SYM_VALUE(FIX)			0
101 #define HANDLE_ALIGN(f)				nds32_handle_align (f)
102 #undef DIFF_EXPR_OK				/* They should be fixed in linker.  */
103 #define md_relax_frag(segment, fragP, stretch)	nds32_relax_frag (segment, fragP, stretch)
104 #define WORKING_DOT_WORD			/* We don't need to handle .word strangely.  */
105 /* Using to chain fixup with previous fixup.  */
106 #define TC_FIX_TYPE struct fix *
107 #define TC_INIT_FIX_DATA(fixP)		\
108   do					\
109     {					\
110       fixP->tc_fix_data = NULL;		\
111     }					\
112   while (0)
113 
114 /* read.c.  */
115 /* Extend GAS macro handling capability.  */
116 extern void nds32_macro_start (void);
117 extern void nds32_macro_end (void);
118 extern void nds32_macro_info (void *);
119 extern void nds32_start_line_hook (void);
120 extern void nds32_elf_section_change_hook (void);
121 extern void md_begin (void);
122 extern void md_end (void);
123 extern int nds32_start_label (int, int);
124 extern void nds32_cleanup (void);
125 extern void nds32_flush_pending_output (void);
126 extern void nds32_cons_align (int);
127 extern void nds32_check_label (symbolS *);
128 extern void nds32_frob_label (symbolS *);
129 extern void nds32_pre_do_align (int, char *, int, int);
130 extern void nds32_do_align (int);
131 
132 #define md_macro_start()			nds32_macro_start ()
133 #define md_macro_end()				nds32_macro_end ()
134 #define md_macro_info(args)			nds32_macro_info (args)
135 #define TC_START_LABEL(STR, NUL_CHAR, NEXT_CHAR)	\
136   (NEXT_CHAR == ':' && nds32_start_label (0, 0))
137 #define tc_check_label(label)			nds32_check_label (label)
138 #define tc_frob_label(label)			nds32_frob_label (label)
139 #define md_end					md_end
140 #define md_start_line_hook()			nds32_start_line_hook ()
141 #define md_cons_align(n)			nds32_cons_align (n)
142 /* COLE: TODO: Review md_do_align.  */
143 #define md_do_align(N, FILL, LEN, MAX, LABEL)	\
144   nds32_pre_do_align (N, FILL, LEN, MAX);	\
145   if ((N) > 1 && (subseg_text_p (now_seg)	\
146       || strncmp (now_seg->name, ".gcc_except_table", sizeof(".gcc_except_table") - 1) == 0)) \
147     nds32_do_align (N);				\
148   goto LABEL;
149 #define md_elf_section_change_hook()		nds32_elf_section_change_hook ()
150 #define md_flush_pending_output()		nds32_flush_pending_output ()
151 #define md_cleanup()				nds32_cleanup ()
152 #define LOCAL_LABELS_FB				1 /* Permit temporary numeric labels.  */
153 
154 /* frags.c.  */
155 
156 enum FRAG_ATTR
157 {
158   NDS32_FRAG_RELAXABLE  = 0x1,
159   NDS32_FRAG_RELAXED = 0x2,
160   NDS32_FRAG_BRANCH = 0x4,
161   NDS32_FRAG_LABEL = 0x8,
162   NDS32_FRAG_FINAL = 0x10,
163   NDS32_FRAG_RELAXABLE_BRANCH = 0x20,
164   NDS32_FRAG_ALIGN = 0x40
165 };
166 
167 struct nds32_frag_type
168 {
169   relax_substateT flag;
170   struct nds32_opcode *opcode;
171   uint32_t insn;
172   /* To Save previous label fixup if existence.  */
173   struct fix *fixup;
174 };
175 
176 extern void nds32_frag_init (fragS *);
177 
178 #define TC_FRAG_TYPE				struct nds32_frag_type
179 #define TC_FRAG_INIT(fragP)			nds32_frag_init (fragP)
180 
181 /* CFI directive.  */
182 extern void nds32_elf_frame_initial_instructions (void);
183 extern int tc_nds32_regname_to_dw2regnum (char *);
184 
185 #define TARGET_USE_CFIPOP			1
186 #define DWARF2_DEFAULT_RETURN_COLUMN		30
187 #define DWARF2_CIE_DATA_ALIGNMENT		-4
188 #define DWARF2_LINE_MIN_INSN_LENGTH		2
189 
190 #define tc_regname_to_dw2regnum			tc_nds32_regname_to_dw2regnum
191 #define tc_cfi_frame_initial_instructions	tc_nds32_frame_initial_instructions
192 
193 /* COLE: TODO: Review These. They seem to be obsoleted.  */
194 #if 1
195 #define TC_RELOC_RTSYM_LOC_FIXUP(FIX)				\
196    ((FIX)->fx_addsy == NULL					\
197     || (! S_IS_EXTERNAL ((FIX)->fx_addsy)			\
198 	&& ! S_IS_WEAK ((FIX)->fx_addsy)			\
199 	&& S_IS_DEFINED ((FIX)->fx_addsy)			\
200 	&& ! S_IS_COMMON ((FIX)->fx_addsy)))
201 #define TC_HANDLES_FX_DONE
202 /* This arranges for gas/write.c to not apply a relocation if
203    obj_fix_adjustable() says it is not adjustable.  */
204 #define TC_FIX_ADJUSTABLE(fixP) obj_fix_adjustable (fixP)
205 #endif
206 
207 /* Because linker may relax the code, assemble-time expression
208    optimization is not allowed.  */
209 #define md_allow_eh_opt 0
210 
211 /* For nds32 relax.  */
212 enum nds32_br_range
213 {
214   BR_RANGE_S256 = 0,
215   BR_RANGE_S16K,
216   BR_RANGE_S64K,
217   BR_RANGE_S16M,
218   BR_RANGE_U4G,
219   BR_RANGE_NUM
220 };
221 
222 enum nds32_ramp
223 {
224   NDS32_CREATE_LABEL = 1,
225   NDS32_RELAX = (1 << 1), /* Obsolete in the future.  */
226   NDS32_ORIGIN = (1 << 2),
227   NDS32_INSN16 = (1 << 3),
228   NDS32_PTR = (1 << 4),
229   NDS32_ABS = (1 << 5),
230   NDS32_HINT = (1 << 6),
231   NDS32_FIX = (1 << 7),
232   NDS32_ADDEND = (1 << 8),
233   NDS32_SYM = (1 << 9),
234   NDS32_PCREL = (1 << 10)
235 };
236 
237 typedef struct nds32_relax_fixup_info
238 {
239   int offset;
240   int size;
241   /* Reverse branch has to jump to the end of instruction pattern.  */
242   int ramp;
243   enum bfd_reloc_code_real r_type;
244 } nds32_relax_fixup_info_t;
245 
246 typedef struct nds32_cond_field
247 {
248   int offset;
249   int bitpos; /* Register position.  */
250   int bitmask; /* Number of register bits.  */
251   bfd_boolean signed_extend;
252 } nds32_cond_field_t;
253 
254 /* The max relaxation pattern is 20-bytes including the nop.  */
255 #define NDS32_MAXCHAR 20
256 /* In current, the max extended number of instruction for one pseudo instruction
257    is 4, but its number of relocation may be 12.  */
258 #define MAX_RELAX_NUM 4
259 #define MAX_RELAX_FIX 12
260 
261 typedef struct nds32_relax_info
262 {
263   /* Opcode for the instruction.  */
264   const char *opcode;
265   enum nds32_br_range br_range;
266   nds32_cond_field_t cond_field[MAX_RELAX_NUM]; /* TODO: Reuse nds32_field?  */
267   /* Code sequences for different branch range.  */
268   uint32_t relax_code_seq[BR_RANGE_NUM][MAX_RELAX_NUM];
269   nds32_cond_field_t relax_code_condition[BR_RANGE_NUM][MAX_RELAX_NUM];
270   unsigned int relax_code_size[BR_RANGE_NUM];
271   int relax_branch_isize[BR_RANGE_NUM];
272   nds32_relax_fixup_info_t relax_fixup[BR_RANGE_NUM][MAX_RELAX_FIX];
273 } relax_info_t;
274 
275 enum nds32_relax_hint_type
276 {
277   NDS32_RELAX_HINT_NONE = 0,
278   NDS32_RELAX_HINT_LA,
279   NDS32_RELAX_HINT_LS
280 };
281 
282 struct nds32_relax_hint_table
283 {
284   enum nds32_relax_hint_type main_type;
285   unsigned int relax_code_size;
286   uint32_t relax_code_seq[MAX_RELAX_NUM];
287   nds32_relax_fixup_info_t relax_fixup[MAX_RELAX_FIX];
288 };
289 
290 #endif /* TC_NDS32 */
291