]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gas/doc/c-arm.texi
Update year range in copyright notice of binutils files
[thirdparty/binutils-gdb.git] / gas / doc / c-arm.texi
1 @c Copyright (C) 1996-2021 Free Software Foundation, Inc.
2 @c This is part of the GAS manual.
3 @c For copying conditions, see the file as.texinfo.
4
5 @ifset GENERIC
6 @page
7 @node ARM-Dependent
8 @chapter ARM Dependent Features
9 @end ifset
10
11 @ifclear GENERIC
12 @node Machine Dependencies
13 @chapter ARM Dependent Features
14 @end ifclear
15
16 @cindex ARM support
17 @cindex Thumb support
18 @menu
19 * ARM Options:: Options
20 * ARM Syntax:: Syntax
21 * ARM Floating Point:: Floating Point
22 * ARM Directives:: ARM Machine Directives
23 * ARM Opcodes:: Opcodes
24 * ARM Mapping Symbols:: Mapping Symbols
25 * ARM Unwinding Tutorial:: Unwinding
26 @end menu
27
28 @node ARM Options
29 @section Options
30 @cindex ARM options (none)
31 @cindex options for ARM (none)
32
33 @table @code
34
35 @cindex @code{-mcpu=} command-line option, ARM
36 @item -mcpu=@var{processor}[+@var{extension}@dots{}]
37 This option specifies the target processor. The assembler will issue an
38 error message if an attempt is made to assemble an instruction which
39 will not execute on the target processor. The following processor names are
40 recognized:
41 @code{arm1},
42 @code{arm2},
43 @code{arm250},
44 @code{arm3},
45 @code{arm6},
46 @code{arm60},
47 @code{arm600},
48 @code{arm610},
49 @code{arm620},
50 @code{arm7},
51 @code{arm7m},
52 @code{arm7d},
53 @code{arm7dm},
54 @code{arm7di},
55 @code{arm7dmi},
56 @code{arm70},
57 @code{arm700},
58 @code{arm700i},
59 @code{arm710},
60 @code{arm710t},
61 @code{arm720},
62 @code{arm720t},
63 @code{arm740t},
64 @code{arm710c},
65 @code{arm7100},
66 @code{arm7500},
67 @code{arm7500fe},
68 @code{arm7t},
69 @code{arm7tdmi},
70 @code{arm7tdmi-s},
71 @code{arm8},
72 @code{arm810},
73 @code{strongarm},
74 @code{strongarm1},
75 @code{strongarm110},
76 @code{strongarm1100},
77 @code{strongarm1110},
78 @code{arm9},
79 @code{arm920},
80 @code{arm920t},
81 @code{arm922t},
82 @code{arm940t},
83 @code{arm9tdmi},
84 @code{fa526} (Faraday FA526 processor),
85 @code{fa626} (Faraday FA626 processor),
86 @code{arm9e},
87 @code{arm926e},
88 @code{arm926ej-s},
89 @code{arm946e-r0},
90 @code{arm946e},
91 @code{arm946e-s},
92 @code{arm966e-r0},
93 @code{arm966e},
94 @code{arm966e-s},
95 @code{arm968e-s},
96 @code{arm10t},
97 @code{arm10tdmi},
98 @code{arm10e},
99 @code{arm1020},
100 @code{arm1020t},
101 @code{arm1020e},
102 @code{arm1022e},
103 @code{arm1026ej-s},
104 @code{fa606te} (Faraday FA606TE processor),
105 @code{fa616te} (Faraday FA616TE processor),
106 @code{fa626te} (Faraday FA626TE processor),
107 @code{fmp626} (Faraday FMP626 processor),
108 @code{fa726te} (Faraday FA726TE processor),
109 @code{arm1136j-s},
110 @code{arm1136jf-s},
111 @code{arm1156t2-s},
112 @code{arm1156t2f-s},
113 @code{arm1176jz-s},
114 @code{arm1176jzf-s},
115 @code{mpcore},
116 @code{mpcorenovfp},
117 @code{cortex-a5},
118 @code{cortex-a7},
119 @code{cortex-a8},
120 @code{cortex-a9},
121 @code{cortex-a15},
122 @code{cortex-a17},
123 @code{cortex-a32},
124 @code{cortex-a35},
125 @code{cortex-a53},
126 @code{cortex-a55},
127 @code{cortex-a57},
128 @code{cortex-a72},
129 @code{cortex-a73},
130 @code{cortex-a75},
131 @code{cortex-a76},
132 @code{cortex-a76ae},
133 @code{cortex-a77},
134 @code{cortex-a78},
135 @code{cortex-a78ae},
136 @code{cortex-a78c},
137 @code{ares},
138 @code{cortex-r4},
139 @code{cortex-r4f},
140 @code{cortex-r5},
141 @code{cortex-r7},
142 @code{cortex-r8},
143 @code{cortex-r52},
144 @code{cortex-m35p},
145 @code{cortex-m33},
146 @code{cortex-m23},
147 @code{cortex-m7},
148 @code{cortex-m4},
149 @code{cortex-m3},
150 @code{cortex-m1},
151 @code{cortex-m0},
152 @code{cortex-m0plus},
153 @code{cortex-x1},
154 @code{exynos-m1},
155 @code{marvell-pj4},
156 @code{marvell-whitney},
157 @code{neoverse-n1},
158 @code{neoverse-n2},
159 @code{neoverse-v1},
160 @code{xgene1},
161 @code{xgene2},
162 @code{ep9312} (ARM920 with Cirrus Maverick coprocessor),
163 @code{i80200} (Intel XScale processor)
164 @code{iwmmxt} (Intel XScale processor with Wireless MMX technology coprocessor)
165 and
166 @code{xscale}.
167 The special name @code{all} may be used to allow the
168 assembler to accept instructions valid for any ARM processor.
169
170 In addition to the basic instruction set, the assembler can be told to
171 accept various extension mnemonics that extend the processor using the
172 co-processor instruction space. For example, @code{-mcpu=arm920+maverick}
173 is equivalent to specifying @code{-mcpu=ep9312}.
174
175 Multiple extensions may be specified, separated by a @code{+}. The
176 extensions should be specified in ascending alphabetical order.
177
178 Some extensions may be restricted to particular architectures; this is
179 documented in the list of extensions below.
180
181 Extension mnemonics may also be removed from those the assembler accepts.
182 This is done be prepending @code{no} to the option that adds the extension.
183 Extensions that are removed should be listed after all extensions which have
184 been added, again in ascending alphabetical order. For example,
185 @code{-mcpu=ep9312+nomaverick} is equivalent to specifying @code{-mcpu=arm920}.
186
187
188 The following extensions are currently supported:
189 @code{bf16} (BFloat16 extensions for v8.6-A architecture),
190 @code{i8mm} (Int8 Matrix Multiply extensions for v8.6-A architecture),
191 @code{crc}
192 @code{crypto} (Cryptography Extensions for v8-A architecture, implies @code{fp+simd}),
193 @code{dotprod} (Dot Product Extensions for v8.2-A architecture, implies @code{fp+simd}),
194 @code{fp} (Floating Point Extensions for v8-A architecture),
195 @code{fp16} (FP16 Extensions for v8.2-A architecture, implies @code{fp}),
196 @code{fp16fml} (FP16 Floating Point Multiplication Variant Extensions for v8.2-A architecture, implies @code{fp16}),
197 @code{idiv} (Integer Divide Extensions for v7-A and v7-R architectures),
198 @code{iwmmxt},
199 @code{iwmmxt2},
200 @code{xscale},
201 @code{maverick},
202 @code{mp} (Multiprocessing Extensions for v7-A and v7-R
203 architectures),
204 @code{os} (Operating System for v6M architecture),
205 @code{predres} (Execution and Data Prediction Restriction Instruction for
206 v8-A architectures, added by default from v8.5-A),
207 @code{sb} (Speculation Barrier Instruction for v8-A architectures, added by
208 default from v8.5-A),
209 @code{sec} (Security Extensions for v6K and v7-A architectures),
210 @code{simd} (Advanced SIMD Extensions for v8-A architecture, implies @code{fp}),
211 @code{virt} (Virtualization Extensions for v7-A architecture, implies
212 @code{idiv}),
213 @code{pan} (Privileged Access Never Extensions for v8-A architecture),
214 @code{ras} (Reliability, Availability and Serviceability extensions
215 for v8-A architecture),
216 @code{rdma} (ARMv8.1 Advanced SIMD extensions for v8-A architecture, implies
217 @code{simd})
218 and
219 @code{xscale}.
220
221 @cindex @code{-march=} command-line option, ARM
222 @item -march=@var{architecture}[+@var{extension}@dots{}]
223 This option specifies the target architecture. The assembler will issue
224 an error message if an attempt is made to assemble an instruction which
225 will not execute on the target architecture. The following architecture
226 names are recognized:
227 @code{armv1},
228 @code{armv2},
229 @code{armv2a},
230 @code{armv2s},
231 @code{armv3},
232 @code{armv3m},
233 @code{armv4},
234 @code{armv4xm},
235 @code{armv4t},
236 @code{armv4txm},
237 @code{armv5},
238 @code{armv5t},
239 @code{armv5txm},
240 @code{armv5te},
241 @code{armv5texp},
242 @code{armv6},
243 @code{armv6j},
244 @code{armv6k},
245 @code{armv6z},
246 @code{armv6kz},
247 @code{armv6-m},
248 @code{armv6s-m},
249 @code{armv7},
250 @code{armv7-a},
251 @code{armv7ve},
252 @code{armv7-r},
253 @code{armv7-m},
254 @code{armv7e-m},
255 @code{armv8-a},
256 @code{armv8.1-a},
257 @code{armv8.2-a},
258 @code{armv8.3-a},
259 @code{armv8-r},
260 @code{armv8.4-a},
261 @code{armv8.5-a},
262 @code{armv8-m.base},
263 @code{armv8-m.main},
264 @code{armv8.1-m.main},
265 @code{armv8.6-a},
266 @code{iwmmxt},
267 @code{iwmmxt2}
268 and
269 @code{xscale}.
270 If both @code{-mcpu} and
271 @code{-march} are specified, the assembler will use
272 the setting for @code{-mcpu}.
273
274 The architecture option can be extended with a set extension options. These
275 extensions are context sensitive, i.e. the same extension may mean different
276 things when used with different architectures. When used together with a
277 @code{-mfpu} option, the union of both feature enablement is taken.
278 See their availability and meaning below:
279
280 For @code{armv5te}, @code{armv5texp}, @code{armv5tej}, @code{armv6}, @code{armv6j}, @code{armv6k}, @code{armv6z}, @code{armv6kz}, @code{armv6zk}, @code{armv6t2}, @code{armv6kt2} and @code{armv6zt2}:
281
282 @code{+fp}: Enables VFPv2 instructions.
283 @code{+nofp}: Disables all FPU instrunctions.
284
285 For @code{armv7}:
286
287 @code{+fp}: Enables VFPv3 instructions with 16 double-word registers.
288 @code{+nofp}: Disables all FPU instructions.
289
290 For @code{armv7-a}:
291
292 @code{+fp}: Enables VFPv3 instructions with 16 double-word registers.
293 @code{+vfpv3-d16}: Alias for @code{+fp}.
294 @code{+vfpv3}: Enables VFPv3 instructions with 32 double-word registers.
295 @code{+vfpv3-d16-fp16}: Enables VFPv3 with half precision floating-point
296 conversion instructions and 16 double-word registers.
297 @code{+vfpv3-fp16}: Enables VFPv3 with half precision floating-point conversion
298 instructions and 32 double-word registers.
299 @code{+vfpv4-d16}: Enables VFPv4 instructions with 16 double-word registers.
300 @code{+vfpv4}: Enables VFPv4 instructions with 32 double-word registers.
301 @code{+simd}: Enables VFPv3 and NEONv1 instructions with 32 double-word
302 registers.
303 @code{+neon}: Alias for @code{+simd}.
304 @code{+neon-vfpv3}: Alias for @code{+simd}.
305 @code{+neon-fp16}: Enables VFPv3, half precision floating-point conversion and
306 NEONv1 instructions with 32 double-word registers.
307 @code{+neon-vfpv4}: Enables VFPv4 and NEONv1 with Fused-MAC instructions and 32
308 double-word registers.
309 @code{+mp}: Enables Multiprocessing Extensions.
310 @code{+sec}: Enables Security Extensions.
311 @code{+nofp}: Disables all FPU and NEON instructions.
312 @code{+nosimd}: Disables all NEON instructions.
313
314 For @code{armv7ve}:
315
316 @code{+fp}: Enables VFPv4 instructions with 16 double-word registers.
317 @code{+vfpv4-d16}: Alias for @code{+fp}.
318 @code{+vfpv3-d16}: Enables VFPv3 instructions with 16 double-word registers.
319 @code{+vfpv3}: Enables VFPv3 instructions with 32 double-word registers.
320 @code{+vfpv3-d16-fp16}: Enables VFPv3 with half precision floating-point
321 conversion instructions and 16 double-word registers.
322 @code{+vfpv3-fp16}: Enables VFPv3 with half precision floating-point conversion
323 instructions and 32 double-word registers.
324 @code{+vfpv4}: Enables VFPv4 instructions with 32 double-word registers.
325 @code{+simd}: Enables VFPv4 and NEONv1 with Fused-MAC instructions and 32
326 double-word registers.
327 @code{+neon-vfpv4}: Alias for @code{+simd}.
328 @code{+neon}: Enables VFPv3 and NEONv1 instructions with 32 double-word
329 registers.
330 @code{+neon-vfpv3}: Alias for @code{+neon}.
331 @code{+neon-fp16}: Enables VFPv3, half precision floating-point conversion and
332 NEONv1 instructions with 32 double-word registers.
333 double-word registers.
334 @code{+nofp}: Disables all FPU and NEON instructions.
335 @code{+nosimd}: Disables all NEON instructions.
336
337 For @code{armv7-r}:
338
339 @code{+fp.sp}: Enables single-precision only VFPv3 instructions with 16
340 double-word registers.
341 @code{+vfpv3xd}: Alias for @code{+fp.sp}.
342 @code{+fp}: Enables VFPv3 instructions with 16 double-word registers.
343 @code{+vfpv3-d16}: Alias for @code{+fp}.
344 @code{+vfpv3xd-fp16}: Enables single-precision only VFPv3 and half
345 floating-point conversion instructions with 16 double-word registers.
346 @code{+vfpv3-d16-fp16}: Enables VFPv3 and half precision floating-point
347 conversion instructions with 16 double-word registers.
348 @code{+idiv}: Enables integer division instructions in ARM mode.
349 @code{+nofp}: Disables all FPU instructions.
350
351 For @code{armv7e-m}:
352
353 @code{+fp}: Enables single-precision only VFPv4 instructions with 16
354 double-word registers.
355 @code{+vfpvf4-sp-d16}: Alias for @code{+fp}.
356 @code{+fpv5}: Enables single-precision only VFPv5 instructions with 16
357 double-word registers.
358 @code{+fp.dp}: Enables VFPv5 instructions with 16 double-word registers.
359 @code{+fpv5-d16"}: Alias for @code{+fp.dp}.
360 @code{+nofp}: Disables all FPU instructions.
361
362 For @code{armv8-m.main}:
363
364 @code{+dsp}: Enables DSP Extension.
365 @code{+fp}: Enables single-precision only VFPv5 instructions with 16
366 double-word registers.
367 @code{+fp.dp}: Enables VFPv5 instructions with 16 double-word registers.
368 @code{+cdecp0} (CDE extensions for v8-m architecture with coprocessor 0),
369 @code{+cdecp1} (CDE extensions for v8-m architecture with coprocessor 1),
370 @code{+cdecp2} (CDE extensions for v8-m architecture with coprocessor 2),
371 @code{+cdecp3} (CDE extensions for v8-m architecture with coprocessor 3),
372 @code{+cdecp4} (CDE extensions for v8-m architecture with coprocessor 4),
373 @code{+cdecp5} (CDE extensions for v8-m architecture with coprocessor 5),
374 @code{+cdecp6} (CDE extensions for v8-m architecture with coprocessor 6),
375 @code{+cdecp7} (CDE extensions for v8-m architecture with coprocessor 7),
376 @code{+nofp}: Disables all FPU instructions.
377 @code{+nodsp}: Disables DSP Extension.
378
379 For @code{armv8.1-m.main}:
380
381 @code{+dsp}: Enables DSP Extension.
382 @code{+fp}: Enables single and half precision scalar Floating Point Extensions
383 for Armv8.1-M Mainline with 16 double-word registers.
384 @code{+fp.dp}: Enables double precision scalar Floating Point Extensions for
385 Armv8.1-M Mainline, implies @code{+fp}.
386 @code{+mve}: Enables integer only M-profile Vector Extension for
387 Armv8.1-M Mainline, implies @code{+dsp}.
388 @code{+mve.fp}: Enables Floating Point M-profile Vector Extension for
389 Armv8.1-M Mainline, implies @code{+mve} and @code{+fp}.
390 @code{+nofp}: Disables all FPU instructions.
391 @code{+nodsp}: Disables DSP Extension.
392 @code{+nomve}: Disables all M-profile Vector Extensions.
393
394 For @code{armv8-a}:
395
396 @code{+crc}: Enables CRC32 Extension.
397 @code{+simd}: Enables VFP and NEON for Armv8-A.
398 @code{+crypto}: Enables Cryptography Extensions for Armv8-A, implies
399 @code{+simd}.
400 @code{+sb}: Enables Speculation Barrier Instruction for Armv8-A.
401 @code{+predres}: Enables Execution and Data Prediction Restriction Instruction
402 for Armv8-A.
403 @code{+nofp}: Disables all FPU, NEON and Cryptography Extensions.
404 @code{+nocrypto}: Disables Cryptography Extensions.
405
406 For @code{armv8.1-a}:
407
408 @code{+simd}: Enables VFP and NEON for Armv8.1-A.
409 @code{+crypto}: Enables Cryptography Extensions for Armv8-A, implies
410 @code{+simd}.
411 @code{+sb}: Enables Speculation Barrier Instruction for Armv8-A.
412 @code{+predres}: Enables Execution and Data Prediction Restriction Instruction
413 for Armv8-A.
414 @code{+nofp}: Disables all FPU, NEON and Cryptography Extensions.
415 @code{+nocrypto}: Disables Cryptography Extensions.
416
417 For @code{armv8.2-a} and @code{armv8.3-a}:
418
419 @code{+simd}: Enables VFP and NEON for Armv8.1-A.
420 @code{+fp16}: Enables FP16 Extension for Armv8.2-A, implies @code{+simd}.
421 @code{+fp16fml}: Enables FP16 Floating Point Multiplication Variant Extensions
422 for Armv8.2-A, implies @code{+fp16}.
423 @code{+crypto}: Enables Cryptography Extensions for Armv8-A, implies
424 @code{+simd}.
425 @code{+dotprod}: Enables Dot Product Extensions for Armv8.2-A, implies
426 @code{+simd}.
427 @code{+sb}: Enables Speculation Barrier Instruction for Armv8-A.
428 @code{+predres}: Enables Execution and Data Prediction Restriction Instruction
429 for Armv8-A.
430 @code{+nofp}: Disables all FPU, NEON, Cryptography and Dot Product Extensions.
431 @code{+nocrypto}: Disables Cryptography Extensions.
432
433 For @code{armv8.4-a}:
434
435 @code{+simd}: Enables VFP and NEON for Armv8.1-A and Dot Product Extensions for
436 Armv8.2-A.
437 @code{+fp16}: Enables FP16 Floating Point and Floating Point Multiplication
438 Variant Extensions for Armv8.2-A, implies @code{+simd}.
439 @code{+crypto}: Enables Cryptography Extensions for Armv8-A, implies
440 @code{+simd}.
441 @code{+sb}: Enables Speculation Barrier Instruction for Armv8-A.
442 @code{+predres}: Enables Execution and Data Prediction Restriction Instruction
443 for Armv8-A.
444 @code{+nofp}: Disables all FPU, NEON, Cryptography and Dot Product Extensions.
445 @code{+nocryptp}: Disables Cryptography Extensions.
446
447 For @code{armv8.5-a}:
448
449 @code{+simd}: Enables VFP and NEON for Armv8.1-A and Dot Product Extensions for
450 Armv8.2-A.
451 @code{+fp16}: Enables FP16 Floating Point and Floating Point Multiplication
452 Variant Extensions for Armv8.2-A, implies @code{+simd}.
453 @code{+crypto}: Enables Cryptography Extensions for Armv8-A, implies
454 @code{+simd}.
455 @code{+nofp}: Disables all FPU, NEON, Cryptography and Dot Product Extensions.
456 @code{+nocryptp}: Disables Cryptography Extensions.
457
458
459 @cindex @code{-mfpu=} command-line option, ARM
460 @item -mfpu=@var{floating-point-format}
461
462 This option specifies the floating point format to assemble for. The
463 assembler will issue an error message if an attempt is made to assemble
464 an instruction which will not execute on the target floating point unit.
465 The following format options are recognized:
466 @code{softfpa},
467 @code{fpe},
468 @code{fpe2},
469 @code{fpe3},
470 @code{fpa},
471 @code{fpa10},
472 @code{fpa11},
473 @code{arm7500fe},
474 @code{softvfp},
475 @code{softvfp+vfp},
476 @code{vfp},
477 @code{vfp10},
478 @code{vfp10-r0},
479 @code{vfp9},
480 @code{vfpxd},
481 @code{vfpv2},
482 @code{vfpv3},
483 @code{vfpv3-fp16},
484 @code{vfpv3-d16},
485 @code{vfpv3-d16-fp16},
486 @code{vfpv3xd},
487 @code{vfpv3xd-d16},
488 @code{vfpv4},
489 @code{vfpv4-d16},
490 @code{fpv4-sp-d16},
491 @code{fpv5-sp-d16},
492 @code{fpv5-d16},
493 @code{fp-armv8},
494 @code{arm1020t},
495 @code{arm1020e},
496 @code{arm1136jf-s},
497 @code{maverick},
498 @code{neon},
499 @code{neon-vfpv3},
500 @code{neon-fp16},
501 @code{neon-vfpv4},
502 @code{neon-fp-armv8},
503 @code{crypto-neon-fp-armv8},
504 @code{neon-fp-armv8.1}
505 and
506 @code{crypto-neon-fp-armv8.1}.
507
508 In addition to determining which instructions are assembled, this option
509 also affects the way in which the @code{.double} assembler directive behaves
510 when assembling little-endian code.
511
512 The default is dependent on the processor selected. For Architecture 5 or
513 later, the default is to assemble for VFP instructions; for earlier
514 architectures the default is to assemble for FPA instructions.
515
516 @cindex @code{-mfp16-format=} command-line option
517 @item -mfp16-format=@var{format}
518 This option specifies the half-precision floating point format to use
519 when assembling floating point numbers emitted by the @code{.float16}
520 directive.
521 The following format options are recognized:
522 @code{ieee},
523 @code{alternative}.
524 If @code{ieee} is specified then the IEEE 754-2008 half-precision floating
525 point format is used, if @code{alternative} is specified then the Arm
526 alternative half-precision format is used. If this option is set on the
527 command line then the format is fixed and cannot be changed with
528 the @code{float16_format} directive. If this value is not set then
529 the IEEE 754-2008 format is used until the format is explicitly set with
530 the @code{float16_format} directive.
531
532 @cindex @code{-mthumb} command-line option, ARM
533 @item -mthumb
534 This option specifies that the assembler should start assembling Thumb
535 instructions; that is, it should behave as though the file starts with a
536 @code{.code 16} directive.
537
538 @cindex @code{-mthumb-interwork} command-line option, ARM
539 @item -mthumb-interwork
540 This option specifies that the output generated by the assembler should
541 be marked as supporting interworking. It also affects the behaviour
542 of the @code{ADR} and @code{ADRL} pseudo opcodes.
543
544 @cindex @code{-mimplicit-it} command-line option, ARM
545 @item -mimplicit-it=never
546 @itemx -mimplicit-it=always
547 @itemx -mimplicit-it=arm
548 @itemx -mimplicit-it=thumb
549 The @code{-mimplicit-it} option controls the behavior of the assembler when
550 conditional instructions are not enclosed in IT blocks.
551 There are four possible behaviors.
552 If @code{never} is specified, such constructs cause a warning in ARM
553 code and an error in Thumb-2 code.
554 If @code{always} is specified, such constructs are accepted in both
555 ARM and Thumb-2 code, where the IT instruction is added implicitly.
556 If @code{arm} is specified, such constructs are accepted in ARM code
557 and cause an error in Thumb-2 code.
558 If @code{thumb} is specified, such constructs cause a warning in ARM
559 code and are accepted in Thumb-2 code. If you omit this option, the
560 behavior is equivalent to @code{-mimplicit-it=arm}.
561
562 @cindex @code{-mapcs-26} command-line option, ARM
563 @cindex @code{-mapcs-32} command-line option, ARM
564 @item -mapcs-26
565 @itemx -mapcs-32
566 These options specify that the output generated by the assembler should
567 be marked as supporting the indicated version of the Arm Procedure.
568 Calling Standard.
569
570 @cindex @code{-matpcs} command-line option, ARM
571 @item -matpcs
572 This option specifies that the output generated by the assembler should
573 be marked as supporting the Arm/Thumb Procedure Calling Standard. If
574 enabled this option will cause the assembler to create an empty
575 debugging section in the object file called .arm.atpcs. Debuggers can
576 use this to determine the ABI being used by.
577
578 @cindex @code{-mapcs-float} command-line option, ARM
579 @item -mapcs-float
580 This indicates the floating point variant of the APCS should be
581 used. In this variant floating point arguments are passed in FP
582 registers rather than integer registers.
583
584 @cindex @code{-mapcs-reentrant} command-line option, ARM
585 @item -mapcs-reentrant
586 This indicates that the reentrant variant of the APCS should be used.
587 This variant supports position independent code.
588
589 @cindex @code{-mfloat-abi=} command-line option, ARM
590 @item -mfloat-abi=@var{abi}
591 This option specifies that the output generated by the assembler should be
592 marked as using specified floating point ABI.
593 The following values are recognized:
594 @code{soft},
595 @code{softfp}
596 and
597 @code{hard}.
598
599 @cindex @code{-eabi=} command-line option, ARM
600 @item -meabi=@var{ver}
601 This option specifies which EABI version the produced object files should
602 conform to.
603 The following values are recognized:
604 @code{gnu},
605 @code{4}
606 and
607 @code{5}.
608
609 @cindex @code{-EB} command-line option, ARM
610 @item -EB
611 This option specifies that the output generated by the assembler should
612 be marked as being encoded for a big-endian processor.
613
614 Note: If a program is being built for a system with big-endian data
615 and little-endian instructions then it should be assembled with the
616 @option{-EB} option, (all of it, code and data) and then linked with
617 the @option{--be8} option. This will reverse the endianness of the
618 instructions back to little-endian, but leave the data as big-endian.
619
620 @cindex @code{-EL} command-line option, ARM
621 @item -EL
622 This option specifies that the output generated by the assembler should
623 be marked as being encoded for a little-endian processor.
624
625 @cindex @code{-k} command-line option, ARM
626 @cindex PIC code generation for ARM
627 @item -k
628 This option specifies that the output of the assembler should be marked
629 as position-independent code (PIC).
630
631 @cindex @code{--fix-v4bx} command-line option, ARM
632 @item --fix-v4bx
633 Allow @code{BX} instructions in ARMv4 code. This is intended for use with
634 the linker option of the same name.
635
636 @cindex @code{-mwarn-deprecated} command-line option, ARM
637 @item -mwarn-deprecated
638 @itemx -mno-warn-deprecated
639 Enable or disable warnings about using deprecated options or
640 features. The default is to warn.
641
642 @cindex @code{-mccs} command-line option, ARM
643 @item -mccs
644 Turns on CodeComposer Studio assembly syntax compatibility mode.
645
646 @cindex @code{-mwarn-syms} command-line option, ARM
647 @item -mwarn-syms
648 @itemx -mno-warn-syms
649 Enable or disable warnings about symbols that match the names of ARM
650 instructions. The default is to warn.
651
652 @end table
653
654
655 @node ARM Syntax
656 @section Syntax
657 @menu
658 * ARM-Instruction-Set:: Instruction Set
659 * ARM-Chars:: Special Characters
660 * ARM-Regs:: Register Names
661 * ARM-Relocations:: Relocations
662 * ARM-Neon-Alignment:: NEON Alignment Specifiers
663 @end menu
664
665 @node ARM-Instruction-Set
666 @subsection Instruction Set Syntax
667 Two slightly different syntaxes are support for ARM and THUMB
668 instructions. The default, @code{divided}, uses the old style where
669 ARM and THUMB instructions had their own, separate syntaxes. The new,
670 @code{unified} syntax, which can be selected via the @code{.syntax}
671 directive, and has the following main features:
672
673 @itemize @bullet
674 @item
675 Immediate operands do not require a @code{#} prefix.
676
677 @item
678 The @code{IT} instruction may appear, and if it does it is validated
679 against subsequent conditional affixes. In ARM mode it does not
680 generate machine code, in THUMB mode it does.
681
682 @item
683 For ARM instructions the conditional affixes always appear at the end
684 of the instruction. For THUMB instructions conditional affixes can be
685 used, but only inside the scope of an @code{IT} instruction.
686
687 @item
688 All of the instructions new to the V6T2 architecture (and later) are
689 available. (Only a few such instructions can be written in the
690 @code{divided} syntax).
691
692 @item
693 The @code{.N} and @code{.W} suffixes are recognized and honored.
694
695 @item
696 All instructions set the flags if and only if they have an @code{s}
697 affix.
698 @end itemize
699
700 @node ARM-Chars
701 @subsection Special Characters
702
703 @cindex line comment character, ARM
704 @cindex ARM line comment character
705 The presence of a @samp{@@} anywhere on a line indicates the start of
706 a comment that extends to the end of that line.
707
708 If a @samp{#} appears as the first character of a line then the whole
709 line is treated as a comment, but in this case the line could also be
710 a logical line number directive (@pxref{Comments}) or a preprocessor
711 control command (@pxref{Preprocessing}).
712
713 @cindex line separator, ARM
714 @cindex statement separator, ARM
715 @cindex ARM line separator
716 The @samp{;} character can be used instead of a newline to separate
717 statements.
718
719 @cindex immediate character, ARM
720 @cindex ARM immediate character
721 Either @samp{#} or @samp{$} can be used to indicate immediate operands.
722
723 @cindex identifiers, ARM
724 @cindex ARM identifiers
725 *TODO* Explain about /data modifier on symbols.
726
727 @node ARM-Regs
728 @subsection Register Names
729
730 @cindex ARM register names
731 @cindex register names, ARM
732 *TODO* Explain about ARM register naming, and the predefined names.
733
734 @node ARM-Relocations
735 @subsection ARM relocation generation
736
737 @cindex data relocations, ARM
738 @cindex ARM data relocations
739 Specific data relocations can be generated by putting the relocation name
740 in parentheses after the symbol name. For example:
741
742 @smallexample
743 .word foo(TARGET1)
744 @end smallexample
745
746 This will generate an @samp{R_ARM_TARGET1} relocation against the symbol
747 @var{foo}.
748 The following relocations are supported:
749 @code{GOT},
750 @code{GOTOFF},
751 @code{TARGET1},
752 @code{TARGET2},
753 @code{SBREL},
754 @code{TLSGD},
755 @code{TLSLDM},
756 @code{TLSLDO},
757 @code{TLSDESC},
758 @code{TLSCALL},
759 @code{GOTTPOFF},
760 @code{GOT_PREL}
761 and
762 @code{TPOFF}.
763
764 For compatibility with older toolchains the assembler also accepts
765 @code{(PLT)} after branch targets. On legacy targets this will
766 generate the deprecated @samp{R_ARM_PLT32} relocation. On EABI
767 targets it will encode either the @samp{R_ARM_CALL} or
768 @samp{R_ARM_JUMP24} relocation, as appropriate.
769
770 @cindex MOVW and MOVT relocations, ARM
771 Relocations for @samp{MOVW} and @samp{MOVT} instructions can be generated
772 by prefixing the value with @samp{#:lower16:} and @samp{#:upper16}
773 respectively. For example to load the 32-bit address of foo into r0:
774
775 @smallexample
776 MOVW r0, #:lower16:foo
777 MOVT r0, #:upper16:foo
778 @end smallexample
779
780 Relocations @samp{R_ARM_THM_ALU_ABS_G0_NC}, @samp{R_ARM_THM_ALU_ABS_G1_NC},
781 @samp{R_ARM_THM_ALU_ABS_G2_NC} and @samp{R_ARM_THM_ALU_ABS_G3_NC} can be
782 generated by prefixing the value with @samp{#:lower0_7:#},
783 @samp{#:lower8_15:#}, @samp{#:upper0_7:#} and @samp{#:upper8_15:#}
784 respectively. For example to load the 32-bit address of foo into r0:
785
786 @smallexample
787 MOVS r0, #:upper8_15:#foo
788 LSLS r0, r0, #8
789 ADDS r0, #:upper0_7:#foo
790 LSLS r0, r0, #8
791 ADDS r0, #:lower8_15:#foo
792 LSLS r0, r0, #8
793 ADDS r0, #:lower0_7:#foo
794 @end smallexample
795
796 @node ARM-Neon-Alignment
797 @subsection NEON Alignment Specifiers
798
799 @cindex alignment for NEON instructions
800 Some NEON load/store instructions allow an optional address
801 alignment qualifier.
802 The ARM documentation specifies that this is indicated by
803 @samp{@@ @var{align}}. However GAS already interprets
804 the @samp{@@} character as a "line comment" start,
805 so @samp{: @var{align}} is used instead. For example:
806
807 @smallexample
808 vld1.8 @{q0@}, [r0, :128]
809 @end smallexample
810
811 @node ARM Floating Point
812 @section Floating Point
813
814 @cindex floating point, ARM (@sc{ieee})
815 @cindex ARM floating point (@sc{ieee})
816 The ARM family uses @sc{ieee} floating-point numbers.
817
818 @node ARM Directives
819 @section ARM Machine Directives
820
821 @cindex machine directives, ARM
822 @cindex ARM machine directives
823 @table @code
824
825 @c AAAAAAAAAAAAAAAAAAAAAAAAA
826
827 @ifclear ELF
828 @cindex @code{.2byte} directive, ARM
829 @cindex @code{.4byte} directive, ARM
830 @cindex @code{.8byte} directive, ARM
831 @item .2byte @var{expression} [, @var{expression}]*
832 @itemx .4byte @var{expression} [, @var{expression}]*
833 @itemx .8byte @var{expression} [, @var{expression}]*
834 These directives write 2, 4 or 8 byte values to the output section.
835 @end ifclear
836
837 @cindex @code{.align} directive, ARM
838 @item .align @var{expression} [, @var{expression}]
839 This is the generic @var{.align} directive. For the ARM however if the
840 first argument is zero (ie no alignment is needed) the assembler will
841 behave as if the argument had been 2 (ie pad to the next four byte
842 boundary). This is for compatibility with ARM's own assembler.
843
844 @cindex @code{.arch} directive, ARM
845 @item .arch @var{name}
846 Select the target architecture. Valid values for @var{name} are the same as
847 for the @option{-march} command-line option without the instruction set
848 extension.
849
850 Specifying @code{.arch} clears any previously selected architecture
851 extensions.
852
853 @cindex @code{.arch_extension} directive, ARM
854 @item .arch_extension @var{name}
855 Add or remove an architecture extension to the target architecture. Valid
856 values for @var{name} are the same as those accepted as architectural
857 extensions by the @option{-mcpu} and @option{-march} command-line options.
858
859 @code{.arch_extension} may be used multiple times to add or remove extensions
860 incrementally to the architecture being compiled for.
861
862 @cindex @code{.arm} directive, ARM
863 @item .arm
864 This performs the same action as @var{.code 32}.
865
866 @c BBBBBBBBBBBBBBBBBBBBBBBBBB
867
868 @cindex @code{.bss} directive, ARM
869 @item .bss
870 This directive switches to the @code{.bss} section.
871
872 @c CCCCCCCCCCCCCCCCCCCCCCCCCC
873
874 @cindex @code{.cantunwind} directive, ARM
875 @item .cantunwind
876 Prevents unwinding through the current function. No personality routine
877 or exception table data is required or permitted.
878
879 @cindex @code{.code} directive, ARM
880 @item .code @code{[16|32]}
881 This directive selects the instruction set being generated. The value 16
882 selects Thumb, with the value 32 selecting ARM.
883
884 @cindex @code{.cpu} directive, ARM
885 @item .cpu @var{name}
886 Select the target processor. Valid values for @var{name} are the same as
887 for the @option{-mcpu} command-line option without the instruction set
888 extension.
889
890 Specifying @code{.cpu} clears any previously selected architecture
891 extensions.
892
893 @c DDDDDDDDDDDDDDDDDDDDDDDDDD
894
895 @cindex @code{.dn} and @code{.qn} directives, ARM
896 @item @var{name} .dn @var{register name} [@var{.type}] [[@var{index}]]
897 @itemx @var{name} .qn @var{register name} [@var{.type}] [[@var{index}]]
898
899 The @code{dn} and @code{qn} directives are used to create typed
900 and/or indexed register aliases for use in Advanced SIMD Extension
901 (Neon) instructions. The former should be used to create aliases
902 of double-precision registers, and the latter to create aliases of
903 quad-precision registers.
904
905 If these directives are used to create typed aliases, those aliases can
906 be used in Neon instructions instead of writing types after the mnemonic
907 or after each operand. For example:
908
909 @smallexample
910 x .dn d2.f32
911 y .dn d3.f32
912 z .dn d4.f32[1]
913 vmul x,y,z
914 @end smallexample
915
916 This is equivalent to writing the following:
917
918 @smallexample
919 vmul.f32 d2,d3,d4[1]
920 @end smallexample
921
922 Aliases created using @code{dn} or @code{qn} can be destroyed using
923 @code{unreq}.
924
925 @c EEEEEEEEEEEEEEEEEEEEEEEEEE
926
927 @cindex @code{.eabi_attribute} directive, ARM
928 @item .eabi_attribute @var{tag}, @var{value}
929 Set the EABI object attribute @var{tag} to @var{value}.
930
931 The @var{tag} is either an attribute number, or one of the following:
932 @code{Tag_CPU_raw_name}, @code{Tag_CPU_name}, @code{Tag_CPU_arch},
933 @code{Tag_CPU_arch_profile}, @code{Tag_ARM_ISA_use},
934 @code{Tag_THUMB_ISA_use}, @code{Tag_FP_arch}, @code{Tag_WMMX_arch},
935 @code{Tag_Advanced_SIMD_arch}, @code{Tag_MVE_arch}, @code{Tag_PCS_config},
936 @code{Tag_ABI_PCS_R9_use}, @code{Tag_ABI_PCS_RW_data},
937 @code{Tag_ABI_PCS_RO_data}, @code{Tag_ABI_PCS_GOT_use},
938 @code{Tag_ABI_PCS_wchar_t}, @code{Tag_ABI_FP_rounding},
939 @code{Tag_ABI_FP_denormal}, @code{Tag_ABI_FP_exceptions},
940 @code{Tag_ABI_FP_user_exceptions}, @code{Tag_ABI_FP_number_model},
941 @code{Tag_ABI_align_needed}, @code{Tag_ABI_align_preserved},
942 @code{Tag_ABI_enum_size}, @code{Tag_ABI_HardFP_use},
943 @code{Tag_ABI_VFP_args}, @code{Tag_ABI_WMMX_args},
944 @code{Tag_ABI_optimization_goals}, @code{Tag_ABI_FP_optimization_goals},
945 @code{Tag_compatibility}, @code{Tag_CPU_unaligned_access},
946 @code{Tag_FP_HP_extension}, @code{Tag_ABI_FP_16bit_format},
947 @code{Tag_MPextension_use}, @code{Tag_DIV_use},
948 @code{Tag_nodefaults}, @code{Tag_also_compatible_with},
949 @code{Tag_conformance}, @code{Tag_T2EE_use},
950 @code{Tag_Virtualization_use}
951
952 The @var{value} is either a @code{number}, @code{"string"}, or
953 @code{number, "string"} depending on the tag.
954
955 Note - the following legacy values are also accepted by @var{tag}:
956 @code{Tag_VFP_arch}, @code{Tag_ABI_align8_needed},
957 @code{Tag_ABI_align8_preserved}, @code{Tag_VFP_HP_extension},
958
959 @cindex @code{.even} directive, ARM
960 @item .even
961 This directive aligns to an even-numbered address.
962
963 @cindex @code{.extend} directive, ARM
964 @cindex @code{.ldouble} directive, ARM
965 @item .extend @var{expression} [, @var{expression}]*
966 @itemx .ldouble @var{expression} [, @var{expression}]*
967 These directives write 12byte long double floating-point values to the
968 output section. These are not compatible with current ARM processors
969 or ABIs.
970
971 @c FFFFFFFFFFFFFFFFFFFFFFFFFF
972
973 @cindex @code{.float16} directive, ARM
974 @item .float16 @var{value [,...,value_n]}
975 Place the half precision floating point representation of one or more
976 floating-point values into the current section. The exact format of the
977 encoding is specified by @code{.float16_format}. If the format has not
978 been explicitly set yet (either via the @code{.float16_format} directive or
979 the command line option) then the IEEE 754-2008 format is used.
980
981 @cindex @code{.float16_format} directive, ARM
982 @item .float16_format @var{format}
983 Set the format to use when encoding float16 values emitted by
984 the @code{.float16} directive.
985 Once the format has been set it cannot be changed.
986 @code{format} should be one of the following: @code{ieee} (encode in
987 the IEEE 754-2008 half precision format) or @code{alternative} (encode in
988 the Arm alternative half precision format).
989
990 @anchor{arm_fnend}
991 @cindex @code{.fnend} directive, ARM
992 @item .fnend
993 Marks the end of a function with an unwind table entry. The unwind index
994 table entry is created when this directive is processed.
995
996 If no personality routine has been specified then standard personality
997 routine 0 or 1 will be used, depending on the number of unwind opcodes
998 required.
999
1000 @anchor{arm_fnstart}
1001 @cindex @code{.fnstart} directive, ARM
1002 @item .fnstart
1003 Marks the start of a function with an unwind table entry.
1004
1005 @cindex @code{.force_thumb} directive, ARM
1006 @item .force_thumb
1007 This directive forces the selection of Thumb instructions, even if the
1008 target processor does not support those instructions
1009
1010 @cindex @code{.fpu} directive, ARM
1011 @item .fpu @var{name}
1012 Select the floating-point unit to assemble for. Valid values for @var{name}
1013 are the same as for the @option{-mfpu} command-line option.
1014
1015 @c GGGGGGGGGGGGGGGGGGGGGGGGGG
1016 @c HHHHHHHHHHHHHHHHHHHHHHHHHH
1017
1018 @cindex @code{.handlerdata} directive, ARM
1019 @item .handlerdata
1020 Marks the end of the current function, and the start of the exception table
1021 entry for that function. Anything between this directive and the
1022 @code{.fnend} directive will be added to the exception table entry.
1023
1024 Must be preceded by a @code{.personality} or @code{.personalityindex}
1025 directive.
1026
1027 @c IIIIIIIIIIIIIIIIIIIIIIIIII
1028
1029 @cindex @code{.inst} directive, ARM
1030 @item .inst @var{opcode} [ , @dots{} ]
1031 @itemx .inst.n @var{opcode} [ , @dots{} ]
1032 @itemx .inst.w @var{opcode} [ , @dots{} ]
1033 Generates the instruction corresponding to the numerical value @var{opcode}.
1034 @code{.inst.n} and @code{.inst.w} allow the Thumb instruction size to be
1035 specified explicitly, overriding the normal encoding rules.
1036
1037 @c JJJJJJJJJJJJJJJJJJJJJJJJJJ
1038 @c KKKKKKKKKKKKKKKKKKKKKKKKKK
1039 @c LLLLLLLLLLLLLLLLLLLLLLLLLL
1040
1041 @item .ldouble @var{expression} [, @var{expression}]*
1042 See @code{.extend}.
1043
1044 @cindex @code{.ltorg} directive, ARM
1045 @item .ltorg
1046 This directive causes the current contents of the literal pool to be
1047 dumped into the current section (which is assumed to be the .text
1048 section) at the current location (aligned to a word boundary).
1049 @code{GAS} maintains a separate literal pool for each section and each
1050 sub-section. The @code{.ltorg} directive will only affect the literal
1051 pool of the current section and sub-section. At the end of assembly
1052 all remaining, un-empty literal pools will automatically be dumped.
1053
1054 Note - older versions of @code{GAS} would dump the current literal
1055 pool any time a section change occurred. This is no longer done, since
1056 it prevents accurate control of the placement of literal pools.
1057
1058 @c MMMMMMMMMMMMMMMMMMMMMMMMMM
1059
1060 @cindex @code{.movsp} directive, ARM
1061 @item .movsp @var{reg} [, #@var{offset}]
1062 Tell the unwinder that @var{reg} contains an offset from the current
1063 stack pointer. If @var{offset} is not specified then it is assumed to be
1064 zero.
1065
1066 @c NNNNNNNNNNNNNNNNNNNNNNNNNN
1067 @c OOOOOOOOOOOOOOOOOOOOOOOOOO
1068
1069 @cindex @code{.object_arch} directive, ARM
1070 @item .object_arch @var{name}
1071 Override the architecture recorded in the EABI object attribute section.
1072 Valid values for @var{name} are the same as for the @code{.arch} directive.
1073 Typically this is useful when code uses runtime detection of CPU features.
1074
1075 @c PPPPPPPPPPPPPPPPPPPPPPPPPP
1076
1077 @cindex @code{.packed} directive, ARM
1078 @item .packed @var{expression} [, @var{expression}]*
1079 This directive writes 12-byte packed floating-point values to the
1080 output section. These are not compatible with current ARM processors
1081 or ABIs.
1082
1083 @anchor{arm_pad}
1084 @cindex @code{.pad} directive, ARM
1085 @item .pad #@var{count}
1086 Generate unwinder annotations for a stack adjustment of @var{count} bytes.
1087 A positive value indicates the function prologue allocated stack space by
1088 decrementing the stack pointer.
1089
1090 @cindex @code{.personality} directive, ARM
1091 @item .personality @var{name}
1092 Sets the personality routine for the current function to @var{name}.
1093
1094 @cindex @code{.personalityindex} directive, ARM
1095 @item .personalityindex @var{index}
1096 Sets the personality routine for the current function to the EABI standard
1097 routine number @var{index}
1098
1099 @cindex @code{.pool} directive, ARM
1100 @item .pool
1101 This is a synonym for .ltorg.
1102
1103 @c QQQQQQQQQQQQQQQQQQQQQQQQQQ
1104 @c RRRRRRRRRRRRRRRRRRRRRRRRRR
1105
1106 @cindex @code{.req} directive, ARM
1107 @item @var{name} .req @var{register name}
1108 This creates an alias for @var{register name} called @var{name}. For
1109 example:
1110
1111 @smallexample
1112 foo .req r0
1113 @end smallexample
1114
1115 @c SSSSSSSSSSSSSSSSSSSSSSSSSS
1116
1117 @anchor{arm_save}
1118 @cindex @code{.save} directive, ARM
1119 @item .save @var{reglist}
1120 Generate unwinder annotations to restore the registers in @var{reglist}.
1121 The format of @var{reglist} is the same as the corresponding store-multiple
1122 instruction.
1123
1124 @smallexample
1125 @exdent @emph{core registers}
1126 .save @{r4, r5, r6, lr@}
1127 stmfd sp!, @{r4, r5, r6, lr@}
1128 @exdent @emph{FPA registers}
1129 .save f4, 2
1130 sfmfd f4, 2, [sp]!
1131 @exdent @emph{VFP registers}
1132 .save @{d8, d9, d10@}
1133 fstmdx sp!, @{d8, d9, d10@}
1134 @exdent @emph{iWMMXt registers}
1135 .save @{wr10, wr11@}
1136 wstrd wr11, [sp, #-8]!
1137 wstrd wr10, [sp, #-8]!
1138 or
1139 .save wr11
1140 wstrd wr11, [sp, #-8]!
1141 .save wr10
1142 wstrd wr10, [sp, #-8]!
1143 @end smallexample
1144
1145 @anchor{arm_setfp}
1146 @cindex @code{.setfp} directive, ARM
1147 @item .setfp @var{fpreg}, @var{spreg} [, #@var{offset}]
1148 Make all unwinder annotations relative to a frame pointer. Without this
1149 the unwinder will use offsets from the stack pointer.
1150
1151 The syntax of this directive is the same as the @code{add} or @code{mov}
1152 instruction used to set the frame pointer. @var{spreg} must be either
1153 @code{sp} or mentioned in a previous @code{.movsp} directive.
1154
1155 @smallexample
1156 .movsp ip
1157 mov ip, sp
1158 @dots{}
1159 .setfp fp, ip, #4
1160 add fp, ip, #4
1161 @end smallexample
1162
1163 @cindex @code{.secrel32} directive, ARM
1164 @item .secrel32 @var{expression} [, @var{expression}]*
1165 This directive emits relocations that evaluate to the section-relative
1166 offset of each expression's symbol. This directive is only supported
1167 for PE targets.
1168
1169 @cindex @code{.syntax} directive, ARM
1170 @item .syntax [@code{unified} | @code{divided}]
1171 This directive sets the Instruction Set Syntax as described in the
1172 @ref{ARM-Instruction-Set} section.
1173
1174 @c TTTTTTTTTTTTTTTTTTTTTTTTTT
1175
1176 @cindex @code{.thumb} directive, ARM
1177 @item .thumb
1178 This performs the same action as @var{.code 16}.
1179
1180 @cindex @code{.thumb_func} directive, ARM
1181 @item .thumb_func
1182 This directive specifies that the following symbol is the name of a
1183 Thumb encoded function. This information is necessary in order to allow
1184 the assembler and linker to generate correct code for interworking
1185 between Arm and Thumb instructions and should be used even if
1186 interworking is not going to be performed. The presence of this
1187 directive also implies @code{.thumb}
1188
1189 This directive is not necessary when generating EABI objects. On these
1190 targets the encoding is implicit when generating Thumb code.
1191
1192 @cindex @code{.thumb_set} directive, ARM
1193 @item .thumb_set
1194 This performs the equivalent of a @code{.set} directive in that it
1195 creates a symbol which is an alias for another symbol (possibly not yet
1196 defined). This directive also has the added property in that it marks
1197 the aliased symbol as being a thumb function entry point, in the same
1198 way that the @code{.thumb_func} directive does.
1199
1200 @cindex @code{.tlsdescseq} directive, ARM
1201 @item .tlsdescseq @var{tls-variable}
1202 This directive is used to annotate parts of an inlined TLS descriptor
1203 trampoline. Normally the trampoline is provided by the linker, and
1204 this directive is not needed.
1205
1206 @c UUUUUUUUUUUUUUUUUUUUUUUUUU
1207
1208 @cindex @code{.unreq} directive, ARM
1209 @item .unreq @var{alias-name}
1210 This undefines a register alias which was previously defined using the
1211 @code{req}, @code{dn} or @code{qn} directives. For example:
1212
1213 @smallexample
1214 foo .req r0
1215 .unreq foo
1216 @end smallexample
1217
1218 An error occurs if the name is undefined. Note - this pseudo op can
1219 be used to delete builtin in register name aliases (eg 'r0'). This
1220 should only be done if it is really necessary.
1221
1222 @cindex @code{.unwind_raw} directive, ARM
1223 @item .unwind_raw @var{offset}, @var{byte1}, @dots{}
1224 Insert one of more arbitrary unwind opcode bytes, which are known to adjust
1225 the stack pointer by @var{offset} bytes.
1226
1227 For example @code{.unwind_raw 4, 0xb1, 0x01} is equivalent to
1228 @code{.save @{r0@}}
1229
1230 @c VVVVVVVVVVVVVVVVVVVVVVVVVV
1231
1232 @cindex @code{.vsave} directive, ARM
1233 @item .vsave @var{vfp-reglist}
1234 Generate unwinder annotations to restore the VFP registers in @var{vfp-reglist}
1235 using FLDMD. Also works for VFPv3 registers
1236 that are to be restored using VLDM.
1237 The format of @var{vfp-reglist} is the same as the corresponding store-multiple
1238 instruction.
1239
1240 @smallexample
1241 @exdent @emph{VFP registers}
1242 .vsave @{d8, d9, d10@}
1243 fstmdd sp!, @{d8, d9, d10@}
1244 @exdent @emph{VFPv3 registers}
1245 .vsave @{d15, d16, d17@}
1246 vstm sp!, @{d15, d16, d17@}
1247 @end smallexample
1248
1249 Since FLDMX and FSTMX are now deprecated, this directive should be
1250 used in favour of @code{.save} for saving VFP registers for ARMv6 and above.
1251
1252 @c WWWWWWWWWWWWWWWWWWWWWWWWWW
1253 @c XXXXXXXXXXXXXXXXXXXXXXXXXX
1254 @c YYYYYYYYYYYYYYYYYYYYYYYYYY
1255 @c ZZZZZZZZZZZZZZZZZZZZZZZZZZ
1256
1257 @end table
1258
1259 @node ARM Opcodes
1260 @section Opcodes
1261
1262 @cindex ARM opcodes
1263 @cindex opcodes for ARM
1264 @code{@value{AS}} implements all the standard ARM opcodes. It also
1265 implements several pseudo opcodes, including several synthetic load
1266 instructions.
1267
1268 @table @code
1269
1270 @cindex @code{NOP} pseudo op, ARM
1271 @item NOP
1272 @smallexample
1273 nop
1274 @end smallexample
1275
1276 This pseudo op will always evaluate to a legal ARM instruction that does
1277 nothing. Currently it will evaluate to MOV r0, r0.
1278
1279 @cindex @code{LDR reg,=<label>} pseudo op, ARM
1280 @item LDR
1281 @smallexample
1282 ldr <register> , = <expression>
1283 @end smallexample
1284
1285 If expression evaluates to a numeric constant then a MOV or MVN
1286 instruction will be used in place of the LDR instruction, if the
1287 constant can be generated by either of these instructions. Otherwise
1288 the constant will be placed into the nearest literal pool (if it not
1289 already there) and a PC relative LDR instruction will be generated.
1290
1291 @cindex @code{ADR reg,<label>} pseudo op, ARM
1292 @item ADR
1293 @smallexample
1294 adr <register> <label>
1295 @end smallexample
1296
1297 This instruction will load the address of @var{label} into the indicated
1298 register. The instruction will evaluate to a PC relative ADD or SUB
1299 instruction depending upon where the label is located. If the label is
1300 out of range, or if it is not defined in the same file (and section) as
1301 the ADR instruction, then an error will be generated. This instruction
1302 will not make use of the literal pool.
1303
1304 If @var{label} is a thumb function symbol, and thumb interworking has
1305 been enabled via the @option{-mthumb-interwork} option then the bottom
1306 bit of the value stored into @var{register} will be set. This allows
1307 the following sequence to work as expected:
1308
1309 @smallexample
1310 adr r0, thumb_function
1311 blx r0
1312 @end smallexample
1313
1314 @cindex @code{ADRL reg,<label>} pseudo op, ARM
1315 @item ADRL
1316 @smallexample
1317 adrl <register> <label>
1318 @end smallexample
1319
1320 This instruction will load the address of @var{label} into the indicated
1321 register. The instruction will evaluate to one or two PC relative ADD
1322 or SUB instructions depending upon where the label is located. If a
1323 second instruction is not needed a NOP instruction will be generated in
1324 its place, so that this instruction is always 8 bytes long.
1325
1326 If the label is out of range, or if it is not defined in the same file
1327 (and section) as the ADRL instruction, then an error will be generated.
1328 This instruction will not make use of the literal pool.
1329
1330 If @var{label} is a thumb function symbol, and thumb interworking has
1331 been enabled via the @option{-mthumb-interwork} option then the bottom
1332 bit of the value stored into @var{register} will be set.
1333
1334 @end table
1335
1336 For information on the ARM or Thumb instruction sets, see @cite{ARM
1337 Software Development Toolkit Reference Manual}, Advanced RISC Machines
1338 Ltd.
1339
1340 @node ARM Mapping Symbols
1341 @section Mapping Symbols
1342
1343 The ARM ELF specification requires that special symbols be inserted
1344 into object files to mark certain features:
1345
1346 @table @code
1347
1348 @cindex @code{$a}
1349 @item $a
1350 At the start of a region of code containing ARM instructions.
1351
1352 @cindex @code{$t}
1353 @item $t
1354 At the start of a region of code containing THUMB instructions.
1355
1356 @cindex @code{$d}
1357 @item $d
1358 At the start of a region of data.
1359
1360 @end table
1361
1362 The assembler will automatically insert these symbols for you - there
1363 is no need to code them yourself. Support for tagging symbols ($b,
1364 $f, $p and $m) which is also mentioned in the current ARM ELF
1365 specification is not implemented. This is because they have been
1366 dropped from the new EABI and so tools cannot rely upon their
1367 presence.
1368
1369 @node ARM Unwinding Tutorial
1370 @section Unwinding
1371
1372 The ABI for the ARM Architecture specifies a standard format for
1373 exception unwind information. This information is used when an
1374 exception is thrown to determine where control should be transferred.
1375 In particular, the unwind information is used to determine which
1376 function called the function that threw the exception, and which
1377 function called that one, and so forth. This information is also used
1378 to restore the values of callee-saved registers in the function
1379 catching the exception.
1380
1381 If you are writing functions in assembly code, and those functions
1382 call other functions that throw exceptions, you must use assembly
1383 pseudo ops to ensure that appropriate exception unwind information is
1384 generated. Otherwise, if one of the functions called by your assembly
1385 code throws an exception, the run-time library will be unable to
1386 unwind the stack through your assembly code and your program will not
1387 behave correctly.
1388
1389 To illustrate the use of these pseudo ops, we will examine the code
1390 that G++ generates for the following C++ input:
1391
1392 @verbatim
1393 void callee (int *);
1394
1395 int
1396 caller ()
1397 {
1398 int i;
1399 callee (&i);
1400 return i;
1401 }
1402 @end verbatim
1403
1404 This example does not show how to throw or catch an exception from
1405 assembly code. That is a much more complex operation and should
1406 always be done in a high-level language, such as C++, that directly
1407 supports exceptions.
1408
1409 The code generated by one particular version of G++ when compiling the
1410 example above is:
1411
1412 @verbatim
1413 _Z6callerv:
1414 .fnstart
1415 .LFB2:
1416 @ Function supports interworking.
1417 @ args = 0, pretend = 0, frame = 8
1418 @ frame_needed = 1, uses_anonymous_args = 0
1419 stmfd sp!, {fp, lr}
1420 .save {fp, lr}
1421 .LCFI0:
1422 .setfp fp, sp, #4
1423 add fp, sp, #4
1424 .LCFI1:
1425 .pad #8
1426 sub sp, sp, #8
1427 .LCFI2:
1428 sub r3, fp, #8
1429 mov r0, r3
1430 bl _Z6calleePi
1431 ldr r3, [fp, #-8]
1432 mov r0, r3
1433 sub sp, fp, #4
1434 ldmfd sp!, {fp, lr}
1435 bx lr
1436 .LFE2:
1437 .fnend
1438 @end verbatim
1439
1440 Of course, the sequence of instructions varies based on the options
1441 you pass to GCC and on the version of GCC in use. The exact
1442 instructions are not important since we are focusing on the pseudo ops
1443 that are used to generate unwind information.
1444
1445 An important assumption made by the unwinder is that the stack frame
1446 does not change during the body of the function. In particular, since
1447 we assume that the assembly code does not itself throw an exception,
1448 the only point where an exception can be thrown is from a call, such
1449 as the @code{bl} instruction above. At each call site, the same saved
1450 registers (including @code{lr}, which indicates the return address)
1451 must be located in the same locations relative to the frame pointer.
1452
1453 The @code{.fnstart} (@pxref{arm_fnstart,,.fnstart pseudo op}) pseudo
1454 op appears immediately before the first instruction of the function
1455 while the @code{.fnend} (@pxref{arm_fnend,,.fnend pseudo op}) pseudo
1456 op appears immediately after the last instruction of the function.
1457 These pseudo ops specify the range of the function.
1458
1459 Only the order of the other pseudos ops (e.g., @code{.setfp} or
1460 @code{.pad}) matters; their exact locations are irrelevant. In the
1461 example above, the compiler emits the pseudo ops with particular
1462 instructions. That makes it easier to understand the code, but it is
1463 not required for correctness. It would work just as well to emit all
1464 of the pseudo ops other than @code{.fnend} in the same order, but
1465 immediately after @code{.fnstart}.
1466
1467 The @code{.save} (@pxref{arm_save,,.save pseudo op}) pseudo op
1468 indicates registers that have been saved to the stack so that they can
1469 be restored before the function returns. The argument to the
1470 @code{.save} pseudo op is a list of registers to save. If a register
1471 is ``callee-saved'' (as specified by the ABI) and is modified by the
1472 function you are writing, then your code must save the value before it
1473 is modified and restore the original value before the function
1474 returns. If an exception is thrown, the run-time library restores the
1475 values of these registers from their locations on the stack before
1476 returning control to the exception handler. (Of course, if an
1477 exception is not thrown, the function that contains the @code{.save}
1478 pseudo op restores these registers in the function epilogue, as is
1479 done with the @code{ldmfd} instruction above.)
1480
1481 You do not have to save callee-saved registers at the very beginning
1482 of the function and you do not need to use the @code{.save} pseudo op
1483 immediately following the point at which the registers are saved.
1484 However, if you modify a callee-saved register, you must save it on
1485 the stack before modifying it and before calling any functions which
1486 might throw an exception. And, you must use the @code{.save} pseudo
1487 op to indicate that you have done so.
1488
1489 The @code{.pad} (@pxref{arm_pad,,.pad}) pseudo op indicates a
1490 modification of the stack pointer that does not save any registers.
1491 The argument is the number of bytes (in decimal) that are subtracted
1492 from the stack pointer. (On ARM CPUs, the stack grows downwards, so
1493 subtracting from the stack pointer increases the size of the stack.)
1494
1495 The @code{.setfp} (@pxref{arm_setfp,,.setfp pseudo op}) pseudo op
1496 indicates the register that contains the frame pointer. The first
1497 argument is the register that is set, which is typically @code{fp}.
1498 The second argument indicates the register from which the frame
1499 pointer takes its value. The third argument, if present, is the value
1500 (in decimal) added to the register specified by the second argument to
1501 compute the value of the frame pointer. You should not modify the
1502 frame pointer in the body of the function.
1503
1504 If you do not use a frame pointer, then you should not use the
1505 @code{.setfp} pseudo op. If you do not use a frame pointer, then you
1506 should avoid modifying the stack pointer outside of the function
1507 prologue. Otherwise, the run-time library will be unable to find
1508 saved registers when it is unwinding the stack.
1509
1510 The pseudo ops described above are sufficient for writing assembly
1511 code that calls functions which may throw exceptions. If you need to
1512 know more about the object-file format used to represent unwind
1513 information, you may consult the @cite{Exception Handling ABI for the
1514 ARM Architecture} available from @uref{http://infocenter.arm.com}.
1515