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