Armasm User Guide
Armasm User Guide
Version 5.04
ARM Compiler
®
Document History
Proprietary Notice
®
Words and logos marked with ® or ™ are registered trademarks or trademarks of ARM in the EU and other countries,
except as otherwise stated below in this proprietary notice. Other brands and names mentioned herein may be the
trademarks of their respective owners.
Neither the whole nor any part of the information contained in, or the product described in, this document may be adapted
or reproduced in any material form except with the prior written permission of the copyright holder.
The product described in this document is subject to continuous developments and improvements. All particulars of the
product and its use contained in this document are given by ARM in good faith. However, all warranties implied or
expressed, including but not limited to implied warranties of merchantability, or fitness for purpose, are excluded.
This document is intended only to assist the reader in the use of the product. ARM shall not be liable for any loss or
damage arising from the use of any information in this document, or any error or omission in such information, or any
incorrect use of the product.
Where the term ARM is used it means “ARM or any of its subsidiaries as appropriate”.
Confidentiality Status
This document is Non-Confidential. The right to use, copy and disclose this document may be subject to license
restrictions in accordance with the terms of the agreement entered into by ARM and the party that ARM delivered this
document to.
Preface
About this book ..................................................... ..................................................... 23
Figure 2-1 Organization of general-purpose registers and Program Status Registers .......................... 2-43
Figure 8-1 Extension register bank ...................................................................................................... 8-181
Figure 8-2 VFPv2 register banks .......................................................................................................... 8-200
Figure 8-3 VFPv3 register banks .......................................................................................................... 8-200
Figure 10-1 ASR #3 .............................................................................................................................. 10-313
Figure 10-2 LSR #3 .............................................................................................................................. 10-314
Figure 10-3 LSL #3 ............................................................................................................................... 10-314
Figure 10-4 ROR #3 ............................................................................................................................. 10-315
Figure 10-5 RRX .................................................................................................................................. 10-315
Figure 12-1 De-interleaving an array of 3-element structures .............................................................. 12-602
Figure 12-2 Operation of doubleword VEXT for imm = 3 ..................................................................... 12-643
Figure 12-3 Example of operation of VPADAL (in this case for data type I16) ................................... 12-696
Figure 12-4 Example of operation of VPADD (in this case, for data type I16) ..................................... 12-697
Figure 12-5 Example of operation of doubleword VPADDL (in this case, for data type S16) .............. 12-698
Figure 12-6 Operation of quadword VSHL.64 Qd, Qm, #1 .................................................................. 12-728
Figure 12-7 Operation of quadword VSLI.64 Qd, Qm, #1 .................................................................... 12-734
Figure 12-8 Operation of doubleword VSRI.64 Dd, Dm, #2 ................................................................. 12-737
Figure 12-9 Operation of doubleword VTRN.8 ..................................................................................... 12-751
Figure 12-10 Operation of doubleword VTRN.32 ................................................................................... 12-751
Describes the directives that are provided by the ARM assembler, armasm.
Glossary
The ARM Glossary is a list of terms used in ARM documentation, together with definitions for
those terms. The ARM Glossary does not contain terms that are industry standard unless the ARM
meaning differs from the generally accepted meaning.
See the ARM Glossary for more information.
Typographic conventions
italic
Introduces special terminology, denotes cross-references, and citations.
bold
Highlights interface elements, such as menu names. Denotes signal names. Also used for
terms in descriptive lists, where appropriate.
monospace
Denotes text that you can enter at the keyboard, such as commands, file and program
names, and source code.
monospace
Denotes a permitted abbreviation for a command or option. You can enter the underlined
text instead of the full command or option name.
monospace italic
Denotes arguments to monospace text where the argument is to be replaced by a specific
value.
monospace bold
Denotes language keywords when used outside example code.
<and>
Encloses replaceable terms for assembler syntax where they appear in code or code
fragments. For example:
MRC p15, 0 <Rd>, <CRn>, <CRm>, <Opcode_2>
SMALL CAPITALS
Used in body text for a few terms that have specific technical meanings, that are defined
in the ARM glossary. For example, IMPLEMENTATION DEFINED, IMPLEMENTATION SPECIFIC,
UNKNOWN, and UNPREDICTABLE.
Feedback
Feedback on content
If you have comments on content then send an e-mail to [email protected]. Give:
• The title.
• The number ARM DUI0473J.
Other information
• ARM Information Center.
• ARM Technical Support Knowledge Articles.
• Support and Maintenance.
• ARM Glossary.
Related information
Mixing C, C++, and Assembly Language.
Using the Inline and Embedded Assemblers of the ARM Compiler.
Migrating from RVCT v4.0 to ARM Compiler v4.1.
Migrating from RVCT v3.1 to RVCT v4.0.
Related concepts
1.3 How the assembler works on page 1-29.
4.1 About the Unified Assembler Language on page 4-66.
2.6 NEON technology on page 2-40.
4.21 About macros on page 4-94.
8.1 Architecture support for NEON and VFP on page 8-177.
Related references
8 NEON and VFP Programming on page 8-175.
13 Wireless MMX Technology Instructions on page 13-755.
14 Directives Reference on page 14-766.
The following example shows that MOV r1,r2 is seen in pass 1 but not in pass 2:
Related concepts
6.15 Two pass assembler diagnostics on page 6-137.
4.24 Instruction and directive relocations on page 4-98.
Related references
1.4 Directives that can be omitted in pass 2 of the assembler on page 1-31.
9.20 --diag_error=tag[,tag,…] on page 9-239.
9.15 --debug on page 9-234.
Note
Macros that appear only in pass 1 and not in pass 2 must contain only these directives.
The code in the following example assembles without error although the ASSERT directive does
not appear in pass 2:
AREA ||.text||,CODE
x EQU 42
IF :LNOT: :DEF: sym
ASSERT x == 42
ENDIF
sym EQU 1
END
Directives that appear in pass 2 but do not appear in pass 1 cause an assembly error. However, this
does not cause an assembly error when using the ELSE and ELIF directives if their matching IF
directive appears in pass 1. The following example assembles without error because the IF
directive appears in pass 1:
AREA ||.text||,CODE
x EQU 42
IF :DEF: sym
ELSE
ASSERT x == 42
ENDIF
sym EQU 1
END
Related concepts
1.3 How the assembler works on page 1-29.
6.15 Two pass assembler diagnostics on page 6-137.
Related information
ARM Architecture Reference Manual.
Related references
2.20 ARM and Thumb instruction set overview on page 2-55.
Related references
10.22 BLX on page 10-342.
10.23 BX on page 10-344.
11.4 ENTERX and LEAVEX on page 11-590.
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
Note
ARMv6-M and ARMv7-M do not support the same modes as other ARM architectures and
profiles. The processor modes listed here do not apply to ARMv6-M and ARMv7-M.
User mode is an unprivileged mode, and has restricted access to system resources. All other
modes have full access to system resources in the current security state, can change mode freely,
and execute software as privileged.
Applications that require task protection usually execute in User mode. Some embedded
applications might run entirely in any mode other than User mode. An application that requires
full access to system resources usually executes in System mode.
Modes other than User mode are entered to service exceptions, or to access privileged resources.
On an implementation that includes the Security Extensions, code can run in either a secure state
or in a non-secure state.
Related concepts
2.5 Processor modes in ARMv6-M and ARMv7-M on page 2-39.
Related information
ARM Architecture Reference Manual.
Related concepts
2.4 Processor modes, and privileged and unprivileged software execution on page 2-38.
Related information
ARM Architecture Reference Manual.
Note
Not all ARM processors support NEON technology. In particular, there is no NEON support for
architectures before ARMv7.
Related concepts
8.1 Architecture support for NEON and VFP on page 8-177.
8.5 NEON views of the register bank on page 8-182.
Related references
8 NEON and VFP Programming on page 8-175.
Related information
Using the NEON Vectorizing Compiler.
Note
The VFP register bank is shared with the NEON register bank.
Your processor might implement either the VFPv2, VFPv3, or VFPv4 architecture. There are
variants of VFPv3 that differ in the number of accessible registers or differ in its support of the
half-precision extension:
• VFPv3.
• VFPv3-D16.
• VFPv3-FP16.
• VFPv3-D16-FP16.
Related concepts
8.1 Architecture support for NEON and VFP on page 8-177.
8.2 Half-precision extension on page 8-178.
8.6 VFP views of the extension register bank on page 8-183.
Related references
8 NEON and VFP Programming on page 8-175.
Note
The Link Register can also be used as a general-purpose register. The Stack Pointer can be used as
a general-purpose register in ARM state only.
Note
• The monitor mode registers and one of the SPSRs apply only to the monitor mode and are only
present if Security Extensions are implemented.
• In privileged software execution, CPSR is an alias for APSR and gives access to additional
bits.
The following figure shows how the registers are banked in the ARM architecture except ARMv6-
M and ARMv7-M:
Application
level view System level views
Privileged modes
Exception modes
APSR CPSR
SPSR_svc SPSR_mon ‡ SPSR_abt SPSR_und SPSR_irq SPSR_fiq
‡ Monitor mode and the associated banked registers are implemented only as part of the Security Extensions
In ARMv6-M and ARMv-7M based processors, SP is an alias for the two banked stack pointer
registers:
• Main stack pointer register, which is only available in privileged software execution.
• Process stack pointer register.
Related concepts
2.9 General-purpose registers on page 2-44.
2.15 Program Counter on page 2-50.
2.16 Application Program Status Register on page 2-51.
2.19 Saved Program Status Registers on page 2-54.
2.18 Current Program Status Register on page 2-53.
2.4 Processor modes, and privileged and unprivileged software execution on page 2-38.
Related information
ARM Architecture Reference Manual.
Note
When using the --use_frame_pointer option with armcc, do not use R11 as a general-
purpose register.
Related concepts
2.15 Program Counter on page 2-50.
2.10 Register accesses on page 2-45.
Related references
2.11 Predeclared core register names on page 2-46.
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
Related information
--use_frame_pointer.
Related concepts
2.9 General-purpose registers on page 2-44.
2.15 Program Counter on page 2-50.
2.16 Application Program Status Register on page 2-51.
2.18 Current Program Status Register on page 2-53.
2.19 Saved Program Status Registers on page 2-54.
4.19 The Read-Modify-Write operation on page 4-92.
Related references
2.11 Predeclared core register names on page 2-46.
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
With the exception of a1-a4 and v1-v8, you can write the registers either in all upper case or all
lower case.
Related concepts
2.9 General-purpose registers on page 2-44.
Related concepts
8.4 Extension register bank mapping on page 8-180.
The following register names are predeclared when assembling for a Marvell XScale processor
with Wireless MMX:
wR0-wR15, wr0-wr15, and WR0-WR15 Wireless SIMD data registers (coprocesssor 0).
wC0-wC15, wc0-wc15, and WC0-WC15 Usable aliases for coprocessor 1 registers. Use of these aliases is not
recommended.
wCSSF, wcssf, and WCSSF Saturation SIMD flags (coprocessor 1 register c2).
wCASF, wcasf, and WCASF Arithmetic SIMD flags (coprocessor 1 register c3).
wCGR0-wCGR3, wcgr0-wcgr3, and WCGR0- General purpose registers (coprocessor 1 registers c8 - c11).
WCGR3
The predeclared XScale register names are case-sensitive and can be mixed case where this
matches exactly the Wireless MMX Technology specification.
Control registers, ID register, general-purpose registers wCGR0-wCGR3 and the SIMD flags map
onto coprocessor 1. Use the Wireless MMX Technology instructions TMCR and TMRC to read and
write to these registers. The coprocessor 1 registers c4-c7 and c12-c15 are reserved.
SIMD data registers (wR0 - wR15) map onto coprocessor 0 and hold 16x64-bit packed data. Use
the Wireless MMX Technology pseudo-instructions TMRRC and TMCRR to move data between
these registers and the ARM registers.
The assembler supports the WRN and WCN directives to specify your own register names.
Related references
13 Wireless MMX Technology Instructions on page 13-755.
Related references
10.26 CDP and CDP2 on page 10-349.
10.51 MCR and MCR2 on page 10-396.
10.60 MRC and MRC2 on page 10-407.
MOV PC,R0
During execution, PC does not contain the address of the currently executing instruction. The
address of the currently executing instruction is typically PC–8 for ARM, or PC–4 for Thumb.
Note
ARM recommends you use the BX instruction to jump to an address or to return from a function,
rather than writing to the PC directly.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.16 B on page 10-333.
10.21 BL on page 10-340.
10.22 BLX on page 10-342.
10.23 BX on page 10-344.
10.24 BXJ on page 10-346.
10.25 CBZ and CBNZ on page 10-348.
10.150 TBB and TBH on page 10-536.
Related concepts
5.1 Conditional instructions on page 5-106.
5.4 Updates to the condition flags on page 5-109.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.101 SEL on page 10-466.
The state of the Q flag cannot be tested directly by the condition codes. To read the state of the Q
flag, use an MRS instruction.
Related concepts
4.19 The Read-Modify-Write operation on page 4-92.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.76 QADD on page 10-432.
10.123 SMULxy on page 10-491.
10.125 SMULWy on page 10-493.
Related concepts
5.4 Updates to the condition flags on page 5-109.
2.19 Saved Program Status Registers on page 2-54.
Related references
10.38 IT on page 10-366.
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.102 SETEND on page 10-468.
Related concepts
2.18 Current Program Status Register on page 2-53.
Related information
Handling Processor Exceptions.
Data processing These instructions operate on the general-purpose registers. They can perform operations such as
addition, subtraction, or bitwise logic on the contents of two registers and place the result in a
third register. They can also operate on the value in a single register, or on a value in a register
and an immediate value supplied within the instruction.
Long multiply instructions give a 64-bit result in two registers.
Register load and These instructions load or store the value of a single register from or to memory. They can load or
store store a 32-bit word, a 16-bit halfword, or an 8-bit unsigned byte. Byte and halfword loads can
either be sign extended or zero extended to fill the 32-bit register.
A few instructions are also defined that can load or store 64-bit doubleword values into two 32-bit
registers.
Multiple register load These instructions load or store any subset of the general-purpose registers from or to memory.
and store
Status register access These instructions move the contents of a status register to or from a general-purpose register.
Coprocessor These instructions support a general way to extend the ARM architecture. They also enable the
control of the CP15 System Control coprocessor registers.
Related concepts
4.13 Load and store multiple register instructions on page 4-83.
Related references
10 ARM and Thumb Instructions on page 10-296.
Related concepts
4.3 Load 32-bit immediates into registers on page 4-68.
Related references
4.4 Load immediate values using MOV and MVN on page 4-69.
Syntax
Each line of assembly language source code has this general form:
{symbol} {instruction|directive|pseudo-instruction} {;comment}
All three sections of the source line are optional.
symbol is usually a label. In instructions and pseudo-instructions it is always a label. In some
directives it is a symbol for a variable or a constant. The description of the directive makes this
clear in each case.
symbol must begin in the first column. It cannot contain any white space character such as a
space or a tab unless it is enclosed by bars (|).
Labels are symbolic representations of addresses. You can use labels to mark specific addresses
that you want to refer to from other parts of the code. Numeric local labels are a subclass of labels
that begin with a number in the range 0-99. Unlike other labels, a numeric local label can be
defined many times. This makes them useful when generating labels with a macro.
Directives provide important information to the assembler that either affects the assembly process
or affects the final output image.
Instructions and pseudo-instructions make up the code a processor uses to perform tasks.
Note
Instructions, pseudo-instructions, and directives must be preceded by white space, such as a space
or a tab, irrespective of whether there is a preceding label or not.
Some directives do not allow the use of a label.
A comment is the final part of a source line. The first semicolon on a line marks the beginning of a
comment except where the semicolon appears inside a string literal. The end of the line is the end
of the comment. A comment alone is a valid line. The assembler ignores all comments. You can
use blank lines to make your code more readable.
To make source files easier to read, you can split a long line of source into several lines by placing
a backslash character (\) at the end of the line. The backslash must not be followed by any other
characters, including spaces and tabs. The assembler treats the backslash followed by end-of-line
sequence as white space. You can also use blank lines to make your code more readable.
Note
Do not use the backslash followed by end-of-line sequence within quoted strings.
The limit on the length of lines, including any extensions using backslashes, is 4095 characters.
Related concepts
7.6 Labels on page 7-150.
7.10 Numeric local labels on page 7-154.
7.13 String literals on page 7-157.
Related references
7.1 Symbol naming rules on page 7-145.
7.15 Syntax of numeric literals on page 7-159.
3.2 Literals on page 3-60.
3.2 Literals
Assembly language source code can contain numeric, string, Boolean, and single character literals.
Literals can be expressed as:
• Decimal numbers, for example 123.
• Hexadecimal numbers, for example 0x7B.
• Numbers in any base from 2 to 9, for example 5_204 is a number in base 5.
• Floating point numbers, for example 123.4.
• Boolean values {TRUE} or {FALSE}.
• Single character values enclosed by single quotes, for example 'w'.
• Strings enclosed in double quotes, for example "This is a string".
Note
In most cases, a string containing a single character is accepted as a single character value. For
example ADD r0,r1,#"a" is accepted, but ADD r0,r1,#"ab" is faulted.
Related references
3.1 Syntax of source lines in assembly language on page 3-58.
Related concepts
3.4 An example ARM assembly language module on page 3-62.
Related references
14.6 AREA on page 14-774.
Related information
Information about scatter files.
Application entry
The ENTRY directive declares an entry point to the program. It marks the first instruction to be
executed. In applications using the C library, an entry point is also contained within the C library
initialization code. Initialization code and exception handlers also contain entry points.
Application execution
The application code begins executing at the label start, where it loads the decimal values 10
and 3 into registers R0 and R1. These registers are added together and the result placed in R0.
Application termination
After executing the main code, the application terminates by returning control to the debugger.
This is done using the ARM semihosting SVC (0x123456 by default), with the following
parameters:
• R0 equal to angel_SWIreason_ReportException (0x18).
• R1 equal to ADP_Stopped_ApplicationExit (0x20026).
Program end
The END directive instructs the assembler to stop processing this source file. Every assembly
language source module must finish with an END directive on a line by itself. Any lines following
the END directive are ignored by the assembler.
Related concepts
3.3 ELF sections and the AREA directive on page 3-61.
Related references
14.22 END on page 14-793.
14.23 ENTRY on page 14-794.
Related information
What is semihosting?.
Describes the use of a few basic assembly language instructions and the use of macros.
It contains the following:
• 4.1 About the Unified Assembler Language on page 4-66.
• 4.2 Register usage in subroutine calls on page 4-67.
• 4.3 Load 32-bit immediates into registers on page 4-68.
• 4.4 Load immediate values using MOV and MVN on page 4-69.
• 4.5 Load 32-bit values to a register using MOV32 on page 4-72.
• 4.6 Load 32-bit immediate values to a register using LDR Rd, =const on page 4-73.
• 4.7 Literal pools on page 4-74.
• 4.8 Load addresses into registers on page 4-76.
• 4.9 Load addresses to a register using ADR on page 4-77.
• 4.10 Load addresses to a register using ADRL on page 4-79.
• 4.11 Load addresses to a register using LDR Rd, =label on page 4-80.
• 4.12 Other ways to load and store registers on page 4-82.
• 4.13 Load and store multiple register instructions on page 4-83.
• 4.14 Load and store multiple register instructions in ARM and Thumb on page 4-84.
• 4.15 Stack implementation using LDM and STM on page 4-86.
• 4.16 Stack operations for nested subroutines on page 4-88.
• 4.17 Block copy with LDM and STM on page 4-89.
• 4.18 Memory accesses on page 4-91.
• 4.19 The Read-Modify-Write operation on page 4-92.
• 4.20 Optional hash with immediate constants on page 4-93.
Note
The pre-UAL Thumb assembly language does not support 32-bit Thumb instructions.
BL destination
where destination is usually the label on the first instruction of the subroutine.
destination can also be a PC-relative expression.
The BL instruction:
• Places the return address in the link register.
• Sets the PC to the address of the subroutine.
After the subroutine code has executed you can use a BX LR instruction to return.
Note
Calls between separately assembled or compiled modules must comply with the restrictions and
conventions defined by the Procedure Call Standard for the ARM Architecture.
The following example shows a subroutine, doadd, that adds the values of two arguments and
returns a result in R0:
Related concepts
4.16 Stack operations for nested subroutines on page 4-88.
Related references
10.16 B on page 10-333.
Related information
Procedure Call Standard for the ARM Architecture.
Related concepts
4.5 Load 32-bit values to a register using MOV32 on page 4-72.
4.6 Load 32-bit immediate values to a register using LDR Rd, =const on page 4-73.
8.7 Load values to VFP and NEON registers on page 8-184.
Related references
4.4 Load immediate values using MOV and MVN on page 4-69.
10.45 LDR pseudo-instruction on page 10-385.
The following table shows the range of 16-bit values that can be loaded in a single MOV ARM
instruction in ARMv6T2 and later:
Note
These notes give extra information on both tables.
a
The MVN values are only available directly as operands in MVN instructions.
b
These values are available in ARM state only. All the other values in this table are also
available in 32-bit Thumb instructions.
c
These values are only available in ARMv6T2 and later. They are not available directly as
operands in other instructions.
The following table shows the range of 16-bit values that can be loaded by the MOV 32-bit Thumb
instruction:
Note
These notes give extra information on the tables.
a
The MVN values are only available directly as operands in MVN instructions.
b
These values are available directly as operands in ADD, SUB, and MOV instructions, but not
in MVN or any other data processing instructions.
c
These values are only available in MOV instructions.
In both ARM and Thumb, you do not have to decide whether to use MOV or MVN. The assembler
uses whichever is appropriate. This is useful if the value is an assembly-time variable.
If you write an instruction with an immediate value that is not available, the assembler reports the
error: Immediate n out of range for this operation.
Related concepts
4.3 Load 32-bit immediates into registers on page 4-68.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.57 MOV32 pseudo-instruction on page 10-404.
4.6 Load 32-bit immediate values to a register using LDR Rd, =const
The LDR Rd,=const pseudo-instruction generates the most efficient single instruction to load
any 32-bit number.
You can use this pseudo-instruction to generate constants that are out of range of the MOV and MVN
instructions.
The LDR pseudo-instruction generates the most efficient single instruction for the specified
immediate value:
• If the immediate value can be constructed with a single MOV or MVN instruction, the assembler
generates the appropriate instruction.
• If the immediate value cannot be constructed with a single MOV or MVN instruction, the
assembler:
— Places the value in a literal pool (a portion of memory embedded in the code to hold
constant values).
— Generates an LDR instruction with a PC-relative address that reads the constant from the
literal pool.
For example:
You must ensure that there is a literal pool within range of the LDR instruction generated by the
assembler.
Related concepts
4.7 Literal pools on page 4-74.
Related references
10.45 LDR pseudo-instruction on page 10-385.
Related concepts
4.6 Load 32-bit immediate values to a register using LDR Rd, =const on page 4-73.
Related references
14.49 LTORG on page 14-824.
Related concepts
4.9 Load addresses to a register using ADR on page 4-77.
4.10 Load addresses to a register using ADRL on page 4-79.
4.5 Load 32-bit values to a register using MOV32 on page 4-72.
4.11 Load addresses to a register using LDR Rd, =label on page 4-80.
Note
The label used with ADR must be within the same code section. The assembler faults references to
labels that are out of range in the same section.
The available range of addresses for the ADR instruction depends on the instruction set and
encoding:
ARM
Any value that can be produced by rotating an 8-bit value right by any even number of
bits within a 32-bit word. The range is relative to the PC.
32-bit Thumb encoding
±4095 bytes to a byte, halfword, or word-aligned address.
16-bit Thumb encoding
0 to 1020 bytes. label must be word-aligned. You can use the ALIGN directive to ensure
this.
In this example, the function arithfunc takes three arguments and returns a result in R0. The
first argument determines the operation to be carried out on the second and third arguments:
argument1=0
Result = argument2 + argument3.
argument1=1
Result = argument2 – argument3.
The jump table is implemented with the following instructions and assembler directives:
EQU
Is an assembler directive. You use it to give a value to a symbol. In this example, it
assigns the value 2 to num. When num is used elsewhere in the code, the value 2 is
substituted. Using EQU in this way is similar to using #define to define a constant in C.
DCD
Declares one or more words of store. In this example, each DCD stores the address of a
routine that handles a particular clause of the jump table.
LDR
The LDR PC,[R3,R0,LSL#2] instruction loads the address of the required clause of the
jump table into the PC. It:
• Multiplies the clause number in R0 by 4 to give a word offset.
• Adds the result to the address of the jump table.
• Loads the contents of the combined address into the PC.
Related concepts
4.11 Load addresses to a register using LDR Rd, =label on page 4-80.
4.10 Load addresses to a register using ADRL on page 4-79.
Related references
10.11 ADR (PC-relative) on page 10-323.
Note
The label used with ADRL must be within the same code section. The assembler faults references
to labels that are out of range in the same section.
ADRL is not available in Thumb state on processors before ARMv6T2.
Related concepts
4.9 Load addresses to a register using ADR on page 4-77.
4.11 Load addresses to a register using LDR Rd, =label on page 4-80.
The following example shows an ARM code routine that overwrites one string with another. It
uses the LDR pseudo-instruction to load the addresses of the two strings from a data section. The
following are particularly significant:
DCB
The DCB directive defines one or more bytes of store. In addition to integer values, DCB
accepts quoted strings. Each character of the string is placed in a consecutive byte.
LDR, STR
The LDR and STR instructions use post-indexed addressing to update their address
registers. For example, the instruction:
LDRB r2,[r1],#1
loads R2 with the contents of the address pointed to by R1 and then increments R1 by 1.
String copy
AREA StrCopy, CODE, READONLY
ENTRY ; Mark first instruction to execute
start
LDR r1, =srcstr ; Pointer to first string
LDR r0, =dststr ; Pointer to second string
BL strcopy ; Call subroutine to do copy
stop
MOV r0, #0x18 ; angel_SWIreason_ReportException
LDR r1, =0x20026 ; ADP_Stopped_ApplicationExit
SVC #0x123456 ; ARM semihosting (formerly SWI)
strcopy
LDRB r2, [r1],#1 ; Load byte and update address
STRB r2, [r0],#1 ; Store byte and update address
CMP r2, #0 ; Check for zero terminator
BNE strcopy ; Keep going if not
MOV pc,lr ; Return
AREA Strings, DATA, READWRITE
srcstr DCB "First string - source",0
dststr DCB "Second string - destination",0
END
Related concepts
4.10 Load addresses to a register using ADRL on page 4-79.
4.6 Load 32-bit immediate values to a register using LDR Rd, =const on page 4-73.
Related references
10.45 LDR pseudo-instruction on page 10-385.
14.14 DCB on page 14-785.
Related concepts
4.13 Load and store multiple register instructions on page 4-83.
Related references
4.14 Load and store multiple register instructions in ARM and Thumb on page 4-84.
10.56 MOV on page 10-402.
Note
The lowest numbered register is transferred to or from the lowest memory address accessed, and
the highest numbered register to or from the highest address accessed. The order of the registers in
the register list in the instructions makes no difference.
You can use the --diag_warning 1206 assembler command line option to check that registers
in register lists are specified in increasing order.
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
4.16 Stack operations for nested subroutines on page 4-88.
4.17 Block copy with LDM and STM on page 4-89.
Related references
4.14 Load and store multiple register instructions in ARM and Thumb on page 4-84.
4.14 Load and store multiple register instructions in ARM and Thumb
Instructions are available in both the ARM and Thumb instruction sets to load and store multiple
registers.
They are:
LDM
Load Multiple registers.
STM
Store Multiple registers.
PUSH
Store multiple registers onto the stack and update the stack pointer.
POP
Load multiple registers off the stack, and update the stack pointer.
In LDM and STM instructions:
• The list of registers loaded or stored can include:
— In ARM instructions, any or all of R0-R12, SP, LR, and PC.
— In 32-bit Thumb instructions, any or all of R0-R12, and optionally LR or PC (LDM only)
with some restrictions.
— In 16-bit Thumb instructions, any or all of R0-R7.
• The address can be:
— Incremented after each transfer.
— Incremented before each transfer (ARM instructions only).
— Decremented after each transfer (ARM instructions only).
— Decremented before each transfer (not in 16-bit encoded Thumb instructions).
• The base register can be either:
— Updated to point to the next block of data in memory.
— Left as it was before the instruction.
When the base register is updated to point to the next block in memory, this is called writeback,
that is, the adjusted address is written back to the base register.
In PUSH and POP instructions:
• The stack pointer (SP) is the base register, and is always updated.
• The address is incremented after each transfer in POP instructions, and decremented before
each transfer in PUSH instructions.
• The list of registers loaded or stored can include:
— In ARM instructions, any or all of R0-R12, SP, LR, and PC.
— In 32-bit Thumb instructions, any or all of R0-R12, and optionally LR or PC (POP only)
with some restrictions.
— In 16-bit Thumb instructions, any or all of R0-R7, and optionally LR (PUSH only) or PC
(POP only).
Note
Use of SP in the list of registers in these ARM instructions is deprecated.
ARM STM and PUSH instructions that use PC in the list of registers, and ARM LDM and POP
instructions that use both PC and LR in the list of registers are deprecated.
Related concepts
4.13 Load and store multiple register instructions on page 4-83.
Related references
About PUSH and POP instructions.
Stack-oriented suffix For store or push instructions For load or pop instructions
FD (Full Descending stack) DB (Decrement Before) IA (Increment After)
FA (Full Ascending stack) IB (Increment Before) DA (Decrement After)
ED (Empty Descending stack) DA (Decrement After) IB (Increment Before)
EA (Empty Ascending stack) IA (Increment After) DB (Decrement Before)
The following table shows the load and store multiple instructions with the stack-oriented suffixes
for the various stack types:
For example:
Note
The Procedure Call Standard for the ARM Architecture (AAPCS), and the ARM and Thumb C
and C++ compilers always use a full descending stack.
The PUSH and POP instructions assume a full descending stack. They are the preferred synonyms
for STMDB and LDM with writeback.
Related concepts
4.13 Load and store multiple register instructions on page 4-83.
Related references
10.40 LDM on page 10-370.
Related information
Procedure Call Standard for the ARM Architecture.
Note
Use this with care in mixed ARM and Thumb systems. In ARMv4T systems, you cannot change
state by popping directly into PC. In these cases you must pop the address into a temporary
register and use the BX instruction.
In ARMv5T and later, you can change state in this way.
Related concepts
4.2 Register usage in subroutine calls on page 4-67.
Related information
Procedure Call Standard for the ARM Architecture.
Interworking ARM and Thumb.
You can make this module more efficient by using LDM and STM for as much of the copying as
possible. Eight is a sensible number of words to transfer at a time, given the number of registers
that the ARM has. You can find the number of eight-word multiples in the block to be copied (if
R2 = number of words to be copied) using:
You can use this value to control the number of iterations through a loop that copies eight words
per iteration. When there are fewer than eight words left, you can find the number of words left
(assuming that R2 has not been corrupted) using:
The following example lists the block copy module rewritten to use LDM and STM for copying:
wordcopy
LDR r3, [r0], #4 ; Load a word from the source and
STR r3, [r1], #4 ; store it to the destination
SUBS r2, r2, #1 ; Decrement the counter
BNE wordcopy ; ... copy more
stop
MOV r0, #0x18 ; angel_SWIreason_ReportException
LDR r1, =0x20026 ; ADP_Stopped_ApplicationExit
SVC #0x123456 ; ARM semihosting (formerly SWI)
AREA BlockData, DATA, READWRITE
src DCD 1,2,3,4,5,6,7,8,1,2,3,4,5,6,7,8,1,2,3,4
dst DCD 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
END
Pre-indexed addressing
The offset value is applied to an address obtained from the base register. The result is
used as the address for the memory access, and written back into the base register. The
assembly language syntax for this mode is:
[Rn, offset]!
Post-indexed addressing
The address obtained from the base register is used, unchanged, as the address for the
memory access. The offset value is applied to the address, and written back into the base
register. The assembly language syntax for this mode is:
[Rn], offset
Related concepts
6.18 Address alignment on page 6-141.
Related references
2.8 ARM registers on page 2-42.
Related concepts
2.10 Register accesses on page 2-45.
2.17 The Q flag on page 2-52.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
12.77 VMRS on page 12-678.
BKPT 100
MOVT R1, 256
VCEQ.I8 Q1, Q2, 0
Related references
10 ARM and Thumb Instructions on page 10-296.
12 NEON and VFP Instructions on page 12-592.
Related concepts
4.22 Test-and-branch macro example on page 4-95.
4.23 Unsigned integer division macro example on page 4-96.
Related references
14.50 MACRO and MEND on page 14-825.
MACRO
$label TestAndBranch $dest, $reg, $cc
$label CMP $reg, #0
B$cc $dest
MEND
The line after the MACRO directive is the macro prototype statement. This defines the name
(TestAndBranch) you use to invoke the macro. It also defines parameters ($label, $dest,
$reg, and $cc). Unspecified parameters are substituted with an empty string. For this macro you
must give values for $dest, $reg and $cc to avoid syntax errors. The assembler substitutes the
values you give into the code.
This macro can be invoked as follows:
Related concepts
4.21 About macros on page 4-94.
4.23 Unsigned integer division macro example on page 4-96.
7.10 Numeric local labels on page 7-154.
The macro checks that no two parameters use the same register. It also optimizes the code
produced if only the remainder is required.
To avoid multiple definitions of labels if DivMod is used more than once in the assembler source,
the macro uses numeric local labels (90, 91).
The following example shows the code that this macro produces if it is invoked as follows:
Related concepts
4.21 About macros on page 4-94.
4.22 Test-and-branch macro example on page 4-95.
7.10 Numeric local labels on page 7-154.
Note
You can use the RELOC directive to control the relocation at a finer level, but this requires
knowledge of the ABI.
Example
IMPORT sym ; sym is an external symbol
DCW sym ; Because DCW only outputs 16 bits, only the lower
; 16 bits of the address of sym are inserted at
; link-time.
Related references
14.6 AREA on page 14-774.
14.25 EXPORT or GLOBAL on page 14-796.
14.44 IMPORT and EXTERN on page 14-818.
14.57 REQUIRE on page 14-836.
14.56 RELOC on page 14-835.
14.14 DCB on page 14-785.
14.15 DCD and DCDU on page 14-786.
14.21 DCW and DCWU on page 14-792.
10.42 LDR (PC-relative) on page 10-376.
10.11 ADR (PC-relative) on page 10-323.
10.73 PLD, PLDW, and PLI on page 10-427.
10.16 B on page 10-333.
10.25 CBZ and CBNZ on page 10-348.
10.39 LDC and LDC2 on page 10-368.
12.54 VLDR on page 12-655.
13.4 Wireless MMX load and store instructions on page 13-759.
Related information
ELF for the ARM Architecture.
Related concepts
4.27 Exception tables and Unwind tables on page 4-102.
Related references
14.3 About frame directives on page 14-770.
Related information
Procedure Call Standard for the ARM Architecture.
Related concepts
4.26 Frame directives on page 4-101.
Related references
14.3 About frame directives on page 14-770.
9.31 --exceptions, --no_exceptions on page 9-250.
9.32 --exceptions_unwind, --no_exceptions_unwind on page 9-251.
14.36 FRAME UNWIND ON on page 14-808.
14.37 FRAME UNWIND OFF on page 14-809.
14.38 FUNCTION or PROC on page 14-810.
14.39 ENDFUNC or ENDP on page 14-812.
Related information
Exception Handling ABI for the ARM Architecture.
You can use the PUSH and POP mnemonics for full, descending STMFD sp!, {reglist} PUSH {reglist}
stack operations in ARM in addition to Thumb. LDMFD sp!, {reglist} POP {reglist}
You can use the LSL, LSR, ASR, ROR, and RRX instruction MOV Rd, Rn, LSL shift LSL Rd, Rn, shift
mnemonics for instructions with rotations and no other MOV Rd, Rn, LSR shift LSR Rd, Rn, shift
operation, in ARM in addition to Thumb. MOV Rd, Rn, ASR shift ASR Rd, Rn, shift
MOV Rd, Rn, ROR shift ROR Rd, Rn, shift
MOV Rd, Rn, RRX RRX Rd, Rn
Use the label form for PC-relative addressing. Do not use the LDR Rd, [pc, #offset] LDR Rd, label
offset form in new code.
Specify both registers for doubleword memory accesses. You LDRD Rd, addr_mode LDRD Rd, Rd2, addr_mode
must still obey rules about the register combinations you can
use.
{cond}, if used, is always the last element of all instructions. ADD{cond}S ADDS{cond}
LDR{cond}SB LDRSB{cond}
In addition, some flexibility is permitted that was not permitted in previous assemblers as the
following table shows:
You can write source code for Thumb processors earlier than ARMv6T2 using UAL.
If you are writing Thumb code for a processor earlier than ARMv6T2, you must restrict yourself
to instructions that are available on the processor. The assembler generates error messages if you
attempt to use an instruction that is not available.
If you are writing Thumb code for an ARMv6T2 or later processor, you can minimize your code
size by using 16-bit instructions wherever possible.
The following table shows the main differences between the UAL and the pre-UAL Thumb
assembly language:
Table 4-9 Differences between pre-UAL Thumb syntax and UAL syntax
Related references
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
Describes condition codes and the conditional execution of ARM and Thumb code.
It contains the following:
• 5.1 Conditional instructions on page 5-106.
• 5.2 Conditional execution in ARM state on page 5-107.
• 5.3 Conditional execution in Thumb state on page 5-108.
• 5.4 Updates to the condition flags on page 5-109.
• 5.5 Condition code suffixes on page 5-110.
• 5.6 Comparison of condition code meanings on page 5-111.
• 5.7 Benefits of using conditional execution on page 5-113.
• 5.8 Illustration of the benefits of using conditional instructions on page 5-114.
• 5.9 Optimization for execution speed on page 5-117.
Related concepts
5.4 Updates to the condition flags on page 5-109.
5.2 Conditional execution in ARM state on page 5-107.
5.3 Conditional execution in Thumb state on page 5-108.
Related references
5.5 Condition code suffixes on page 5-110.
Related concepts
5.3 Conditional execution in Thumb state on page 5-108.
Related concepts
5.2 Conditional execution in ARM state on page 5-107.
Related references
10.38 IT on page 10-366.
10.25 CBZ and CBNZ on page 10-348.
Note
Most instructions update the condition flags only if the S suffix is specified. The instructions CMP,
CMN, TEQ, and TST always update the flags.
The condition flags are held in the APSR. They are set or cleared as follows:
N
Set to 1 when the result of the operation is negative, cleared to 0 otherwise.
Z
Set to 1 when the result of the operation is zero, cleared to 0 otherwise.
C
Set to 1 when the operation results in a carry, or when a subtraction results in no borrow,
cleared to 0 otherwise.
V
Set to 1 when the operation causes overflow, cleared to 0 otherwise.
C is set in one of the following ways:
• For an addition, including the comparison instruction CMN, C is set to 1 if the addition
produced a carry (that is, an unsigned overflow), and to 0 otherwise.
• For a subtraction, including the comparison instruction CMP, C is set to 0 if the subtraction
produced a borrow (that is, an unsigned underflow), and to 1 otherwise.
• For non-addition/subtractions that incorporate a shift operation, C is set to the last bit shifted
out of the value by the shifter.
• For other non-addition/subtractions, C is normally left unchanged, but see the individual
instruction descriptions for any special cases.
Overflow occurs if the result of a signed add, subtract, or compare is greater than or equal to 231,
or less than –231.
Related concepts
5.1 Conditional instructions on page 5-106.
Related references
5.5 Condition code suffixes on page 5-110.
10 ARM and Thumb Instructions on page 10-296.
The optional condition code is shown in syntax descriptions as {cond}. This condition is encoded
in ARM instructions, and encoded in a preceding IT instruction for Thumb instructions. An
instruction with a condition code is only executed if the condition flags in the APSR meet the
specified condition.
In Thumb state on processors before ARMv6T2, the {cond} field is only permitted on certain
branch instructions because there is no IT instruction on these processors.
The following is an example of conditional execution:
Related concepts
5.1 Conditional instructions on page 5-106.
5.4 Updates to the condition flags on page 5-109.
Related references
10 ARM and Thumb Instructions on page 10-296.
5.6 Comparison of condition code meanings on page 5-111.
The meanings of the condition code mnemonic suffixes are shown in the following table:
Suffix Meaning after ARM data processing instruction Meaning after VFP VCMP instruction
EQ Equal Equal
NE Not equal Not equal, or unordered
CS Carry set Greater than or equal, or unordered
HS Unsigned higher or same Greater than or equal, or unordered
CC Carry clear Less than
LO Unsigned lower Less than
MI Negative Less than
PL Positive or zero Greater than or equal, or unordered
VS Overflow Unordered (at least one NaN operand)
VC No overflow Not unordered
HI Unsigned higher Greater than, or unordered
LS Unsigned lower or same Less than or equal
GE Signed greater than or equal Greater than or equal
LT Signed less than Less than, or unordered
GT Signed greater than Greater than
LE Signed less than or equal Less than or equal, or unordered
AL Always (normally omitted) Always (normally omitted)
Related references
5.5 Condition code suffixes on page 5-110.
12.34 VCMP, VCMPE on page 12-632.
12.77 VMRS on page 12-678.
Related information
ARM Architecture Reference Manual.
Related concepts
5.8 Illustration of the benefits of using conditional instructions on page 5-114.
The following examples show implementations of the gcd algorithm with and without conditional
instructions:
Note
The detailed analysis of execution speed only applies to an ARM7™ processor. The code density
calculations apply to all ARM processors.
The code is seven instructions long because of the number of branches. Every time a branch is
taken, the processor must refill the pipeline and continue from the new location. The other
instructions and non-executed branches use a single cycle each.
The following table shows the number of cycles this implementation uses on an ARM7 processor
when R0 equals 1 and R1 equals 2:
gcd
CMP r0, r1
SUBGT r0, r0, r1
SUBLE r1, r1, r0
BNE gcd
In addition to improving code size, in most cases this code executes faster than the version that
uses only branches.
The following table shows the number of cycles this implementation uses on an ARM7 processor
when R0 equals 1 and R1 equals 2:
gcd
CMP r0, r1
ITE GT
SUBGT r0, r0, r1
SUBLE r1, r1, r0
BNE gcd
This assembles equally well to ARM or Thumb code. The assembler checks the IT instructions,
but omits them on assembly to ARM code.
It requires one more instruction in Thumb code (the IT instruction) than in ARM code, but the
overall code size is 10 bytes in Thumb code compared with 16 bytes in ARM code.
Related concepts
5.7 Benefits of using conditional execution on page 5-113.
5.9 Optimization for execution speed on page 5-117.
Related references
10.38 IT on page 10-366.
5.5 Condition code suffixes on page 5-110.
Related information
ARM Architecture Reference Manual.
Related information
ARM Architecture Reference Manual.
Further reading.
Note
The inline and embedded assemblers are part of the C and C++ compilers and do not use any
command-line syntax for invocation. However, to pass additional assembler options when the
compiler invokes armasm for embedded assembly, you can use the armcc –A option.
The assembler command line is case-insensitive, except in filenames and where specified. The
assembler uses the same command-line ordering rules as the compiler. This means that if the
command line contains options that conflict with each other, then the last option found always
takes precedence.
Related information
Order of compiler command-line options.
Compiler command-line options listed by group.
Related concepts
6.1 Assembler command-line syntax on page 6-119.
Related information
Toolchain environment variables.
Note
In general, you can use a via file to specify any command-line option to a tool, including --via.
This means that you can call multiple nested via files from within a via file.
A comment ends at the end of a line, or at the end of the file. There are no multi-line
comments, and there are no part-line comments.
Note
The source code from stdin is stored in an internal cache that can hold up to 8 MB. You can
increase this cache size using the --maxcache command-line option.
Procedure
1. Invoke the assembler with the command-line options you want to use. Use the minus character
(-) as the source filename to instruct the assembler to take input from stdin. You must
specify the output filename using the -o option. For example:
Related concepts
6.1 Assembler command-line syntax on page 6-119.
Related references
9.48 --maxcache=n on page 9-268.
Related information
Using a text file to specify command-line options.
Compilation tools command-line option rules.
{CPU} Holds the name of the selected processor. The default is "ARM7TDMI". If an
architecture was specified in the command-line --cpu option, {CPU} holds
the value "Generic ARM".
{ENDIAN} Has the value "big" if the assembler is in big-endian mode, or "little" if
it is in little-endian mode.
{FPIC} Has the Boolean value {True} if --apcs=/fpic is set. The default is
{False}.
{FPU} Holds the name of the selected FPU. The default is "SoftVFP".
{INPUTFILE} Holds the name of the current source file.
{INTER} Has the Boolean value True if --apcs=/inter is set. The default is
{False}.
{LINENUM} Holds an integer indicating the line number in the current source file.
{LINENUMUP} When used in a macro, holds an integer indicating the line number of the
current macro. The value is the same as {LINENUM} when used in a non-
macro context.
{LINENUMUPPER} When used in a macro, holds an integer indicating the line number of the top
macro. The value is the same as {LINENUM} when used in a non-macro
context.
{OPT} Value of the currently-set listing option. You can use the OPT directive to
save the current listing option, force a change in it, or restore its original
value.
{PCSTOREOFFSET} Is the offset between the address of the STR PC,[…] or STM Rb,{…, PC}
instruction and the value of PC stored out. This varies depending on the
processor or architecture specified.
{ROPI} Has the Boolean value {True} if --apcs=/ropi is set. The default is
{False}.
{RWPI} Has the Boolean value {True} if --apcs=/rwpi is set. The default is
{False}.
You can use built-in variables in expressions or conditions in assembly source code. For example:
IF {ARCHITECTURE} = "4T"
Note
All built-in string variables contain case-sensitive values. Relational operations on these built-in
variables do not match with strings that contain an incorrect case. Use the command-line options
--cpu and --fpu to determine valid values for {CPU}, {ARCHITECTURE}, and {FPU}.
The assembler defines the built-in Boolean constants TRUE and FALSE.
The following table lists the target processor-related built-in variables that are predefined by the
assembler. Where the value field is empty, the symbol is a Boolean value and the meaning column
describes when its value is {TRUE}.
{TARGET_ARCH_XX} – XX represents the target architecture and its value depends on the
target processor. For example, if you specify the assembler option
--cpu=4T or --cpu=ARM7TDMI then {TARGET_ARCH_4T} is
defined.
{TARGET_FEATURE_CLZ} – If the target processor supports the CLZ instruction (that is,
ARMv5T and later except ARMv6-M).
{TARGET_FEATURE_DOUBLEWORD} – If the target processor supports the LDRD and STRD instructions
(that is, ARMv5TE and later except ARMv6-M).
The following table shows the possible values for {TARGET_ARCH_ARM} and
{TARGET_ARCH_THUMB}, and for XX in the TARGET_ARCH_XX built-in variables. It also shows
how these values relate to versions of the ARM architecture.
Related concepts
6.7 Identifying versions of armasm in source code on page 6-129.
Related references
9.14 --cpu=name on page 9-230.
9.35 --fpu=name on page 9-254.
The assembler also defines the built-in variable |ads$version| for legacy code. This variable
did not exist before ADS and RVCT. If you have to build versions of your code using legacy
development tools, you can test for the built-in variable |ads$version|. If this variable is not
defined, then the assembler is part of a legacy development toolchain. Use code similar to the
following:
IF :DEF: |ads$version|
; code for RealView or ADS
ELSE
; code for SDT (a legacy development toolchain)
ENDIF
Related references
6.6 Built-in variables and constants on page 6-124.
Related concepts
6.9 Interlocks diagnostics on page 6-131.
6.10 Automatic IT block generation on page 6-132.
6.11 Thumb branch target alignment on page 6-133.
6.12 Thumb code size diagnostics on page 6-134.
6.13 ARM and Thumb instruction portability diagnostics on page 6-135.
6.14 Instruction width on page 6-136.
6.15 Two pass assembler diagnostics on page 6-137.
Related references
9.20 --diag_error=tag[,tag,…] on page 9-239.
Note
The assembler does not have an accurate model of the target processor, so these messages are not
reliable when used with a multi-issue processor such as Cortex-A8.
Related concepts
6.8 Diagnostic messages on page 6-130.
6.10 Automatic IT block generation on page 6-132.
6.11 Thumb branch target alignment on page 6-133.
6.14 Instruction width on page 6-136.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
AREA x, CODE
THUMB
MOVNE r0,r1
NOP
IT NE
MOVNE r0,r1
END
IT NE
MOVNE r0,r1
NOP
IT NE
MOVNE r0,r1
You can receive warning messages about this automatic generation of IT blocks when assembling
Thumb code. To do this, use the following command-line option when invoking the assembler:
Related concepts
6.8 Diagnostic messages on page 6-130.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
Related concepts
6.8 Diagnostic messages on page 6-130.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
Related concepts
6.8 Diagnostic messages on page 6-130.
6.19 Instruction width selection in Thumb on page 6-142.
2.2 ARM, Thumb, and ThumbEE instruction sets on page 2-36.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
It warns for any instruction that cannot be assembled in the other instruction set. This is only a
hint, and other factors, like relocation availability or target distance might affect the accuracy of
the message.
Related concepts
6.8 Diagnostic messages on page 6-130.
2.2 ARM, Thumb, and ThumbEE instruction sets on page 2-36.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
Note
This diagnostic does not produce a warning for relocated branch instructions, because the final
address is not known. The linker might even insert a veneer, if the branch is out of range for a 32-
bit instruction.
Related concepts
6.8 Diagnostic messages on page 6-130.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
The following example shows that the symbol foo is defined after the :DEF: foo test.
Assembling this code with --diag_warning 1907 generates the message:
Warning A1907W: Test for this symbol has been seen and may cause failure in the second
pass.
Related concepts
1.3 How the assembler works on page 1-29.
6.8 Diagnostic messages on page 6-130.
6.10 Automatic IT block generation on page 6-132.
6.11 Thumb branch target alignment on page 6-133.
6.14 Instruction width on page 6-136.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
#define x 1
#define y x+1
#define x 2
int example()
{
#if y == 2
return 1;
#else
return 0;
#endif
}
Conditional assembly is based on variables, and works on each line in turn. Unlike the C
preprocessor, the assembler evaluates expressions. Conditional assembly is controlled by the
following:
• Assembler directives that declare and set the value of variables, for example GBLx, LCLx and
SETx.
• Assembler directives that control the flow of the assembly, for example WHILE, IF and ELSE.
• Assembler directives that define macros, for example MACRO.
• The assembler command-line option --predefine, which pre-executes a GBLx and SETx
directive.
For example, in the following code, the assembler evaluates x+1 at the point at which the SETA
directive occurs, and therefore MOV sets r0 to 1:
GBLA x
GBLA y
x SETA 1
y SETA x+1
x SETA 2
AREA example, CODE
IF y == 2
MOV r0, #1
ELSE
MOV r0, #0
ENDIF
END
Related references
14.2 About assembly control directives on page 14-769.
9.58 --predefine "directive" on page 9-278.
Related information
-Dname[(parm-list)][=def] compiler option.
-Uname compiler option.
Some of the options that armasm passes to armcc are converted to the armcc equivalent
beforehand. These are shown in the following table:
armasm armcc
--16 --thumb
--32 --arm
-i -I
To pass other simple compiler options, such as the preprocessor option -D, you must use the --
cpreproc_opts command-line option. armasm correctly interprets the preprocessed #line
commands. It can generate error messages and debug_line tables using the information in the
#line commands.
The following example shows the commands you write to preprocess and assemble a file,
source.s. The example also passes the compiler options to define a macro called RELEASE, and
to undefine a macro called ALPHA.
If you want to use complex preprocessor options, you must manually call armcc to preprocess the
file before calling armasm. The following example shows the commands you write to manually
preprocess and assemble a file, source.s. In this example, the preprocessor outputs a file called
preprocessed.s, and armasm assembles it.
Related references
9.11 --cpreproc on page 9-227.
9.12 --cpreproc_opts=options on page 9-228.
Related information
Compiler command-line options listed by group.
Related references
9.68 --unaligned_access, --no_unaligned_access on page 9-288.
Related concepts
6.12 Thumb code size diagnostics on page 6-134.
10.2 Instruction width specifiers on page 10-309.
Describes how you can use symbols to represent variables, addresses and constants in code.
It also describes how you can combine these with operators to create numeric or string
expressions.
It contains the following:
• 7.1 Symbol naming rules on page 7-145.
• 7.2 Variables on page 7-146.
• 7.3 Numeric constants on page 7-147.
• 7.4 Assembly time substitution of variables on page 7-148.
• 7.5 Register-relative and PC-relative expressions on page 7-149.
• 7.6 Labels on page 7-150.
• 7.7 Labels for PC-relative addresses on page 7-151.
• 7.8 Labels for register-relative addresses on page 7-152.
• 7.9 Labels for absolute addresses on page 7-153.
• 7.10 Numeric local labels on page 7-154.
• 7.11 Syntax of numeric local labels on page 7-155.
• 7.12 String expressions on page 7-156.
• 7.13 String literals on page 7-157.
• 7.14 Numeric expressions on page 7-158.
• 7.15 Syntax of numeric literals on page 7-159.
• 7.16 Syntax of floating-point literals on page 7-160.
• 7.17 Logical expressions on page 7-161.
• 7.18 Logical literals on page 7-162.
|.text|
The bars are not part of the symbol. You cannot use bars, semicolons, or newlines within the bars.
Related concepts
7.10 Numeric local labels on page 7-154.
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
2.14 Predeclared coprocessor names on page 2-49.
6.6 Built-in variables and constants on page 6-124.
7.2 Variables
You can declare numeric, logical, or string variables using assembler directives.
The value of a variable can be changed as assembly proceeds. Variables are local to the assembler.
This means that in the generated code or data, every instance of the variable has a fixed value.
The type of a variable cannot be changed. Variables are one of the following types:
• Numeric.
• Logical.
• String.
The range of possible values of a numeric variable is the same as the range of possible values of a
numeric constant or numeric expression.
The possible values of a logical variable are {TRUE} or {FALSE}.
The range of possible values of a string variable is the same as the range of values of a string
expression.
Use the GBLA, GBLL, GBLS, LCLA, LCLL, and LCLS directives to declare symbols representing
variables, and assign values to them using the SETA, SETL, and SETS directives.
Example
a SETA 100
L1 MOV R1, #(a*5) ; In the object file, this is MOV R1, #500
a SETA 200 ; Value of 'a' is 200 only after this point.
; The previous instruction is always MOV R1, #500
…
BNE L1 ; When the processor branches to L1, it executes
; MOV R1, #500
Related concepts
7.3 Numeric constants on page 7-147.
7.14 Numeric expressions on page 7-158.
7.12 String expressions on page 7-156.
7.17 Logical expressions on page 7-161.
Related references
14.41 GBLA, GBLL, and GBLS on page 14-814.
14.48 LCLA, LCLL, and LCLS on page 14-823.
14.62 SETA, SETL, and SETS on page 14-842.
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
7.15 Syntax of numeric literals on page 7-159.
14.24 EQU on page 14-795.
Example
; straightforward substitution
GBLS add4ff
;
add4ff SETS "ADD r4,r4,#0xFF" ; set up add4ff
$add4ff.00 ; invoke add4ff
; this produces
ADD r4,r4,#0xFF00
; elaborate substitution
GBLS s1
GBLS s2
GBLS fixup
GBLA count
;
count SETA 14
s1 SETS "a$$b$count" ; s1 now has value a$b0000000E
s2 SETS "abc"
fixup SETS "|xy$s2.z|" ; fixup now has value |xyabcz|
|C$$code| MOV r4,#16 ; but the label here is C$$code
Related references
3.1 Syntax of source lines in assembly language on page 3-58.
7.1 Symbol naming rules on page 7-145.
Note
• In ARM state, the value of the PC is the address of the current instruction plus 8 bytes.
• In Thumb state:
— For B, BL, CBNZ, and CBZ instructions, the value of the PC is the address of the current
instruction plus 4 bytes.
— For all other instructions that use labels, the value of the PC is the address of the current
instruction plus 4 bytes, with bit[1] of the result cleared to 0 to make it word-aligned.
Example
LDR r4,=data+4*n ; n is an assembly-time variable
; code
MOV pc,lr
data DCD value_0
; n-1 DCD directives
DCD value_n ; data+4*n points here
; more DCD directives
Related concepts
7.6 Labels on page 7-150.
Related references
14.51 MAP on page 14-828.
7.6 Labels
A label is a symbol that represents the memory address of an instruction or data.
The address can be PC-relative, register-relative, or absolute. Labels are local to the source file
unless you make them global using the EXPORT directive.
The address given by a label is calculated during assembly. The assembler calculates the address
of a label relative to the origin of the section where the label is defined. A reference to a label
within the same section can use the PC plus or minus an offset. This is called PC-relative
addressing.
Addresses of labels in other sections are calculated at link time, when the linker has allocated
specific locations in memory for each section.
Related concepts
7.7 Labels for PC-relative addresses on page 7-151.
7.8 Labels for register-relative addresses on page 7-152.
7.9 Labels for absolute addresses on page 7-153.
Related references
3.1 Syntax of source lines in assembly language on page 3-58.
14.25 EXPORT or GLOBAL on page 14-796.
Related references
14.6 AREA on page 14-774.
14.14 DCB on page 14-785.
14.15 DCD and DCDU on page 14-786.
14.17 DCFD and DCFDU on page 14-788.
14.18 DCFS and DCFSU on page 14-789.
14.19 DCI on page 14-790.
14.20 DCQ and DCQU on page 14-791.
14.21 DCW and DCWU on page 14-792.
Related references
14.16 DCDO on page 14-787.
14.24 EQU on page 14-795.
14.51 MAP on page 14-828.
14.63 SPACE or FILL on page 14-843.
Related concepts
7.6 Labels on page 7-150.
7.7 Labels for PC-relative addresses on page 7-151.
7.8 Labels for register-relative addresses on page 7-152.
Related references
14.24 EQU on page 14-795.
Related concepts
7.6 Labels on page 7-150.
Related references
3.1 Syntax of source lines in assembly language on page 3-58.
7.11 Syntax of numeric local labels on page 7-155.
14.50 MACRO and MEND on page 14-825.
14.47 KEEP on page 14-822.
14.61 ROUT on page 14-841.
Syntax
n{routname} ; a numeric local label
%{F|B}{A|T}n{routname} ; a reference to a numeric local label
where:
n
is the number of the numeric local label in the range 0-99.
routname
is the name of the current scope.
%
introduces the reference.
F
instructs the assembler to search forwards only.
B
instructs the assembler to search backwards only.
A
instructs the assembler to search all macro levels.
T
instructs the assembler to look at this macro level only.
Usage
If neither F nor B is specified, the assembler searches backwards first, then forwards.
If neither A nor T is specified, the assembler searches all macros from the current level to the top
level, but does not search lower level macros.
If routname is specified in either a label or a reference to a label, the assembler checks it against
the name of the nearest preceding ROUT directive. If it does not match, the assembler generates an
error message and the assembly fails.
Related concepts
7.10 Numeric local labels on page 7-154.
Related references
14.61 ROUT on page 14-841.
Example
improb SETS "literal":CC:(strvar2:LEFT:4)
; sets the variable improb to the value "literal"
; with the left-most four characters of the
; contents of string variable strvar2 appended
Related concepts
7.2 Variables on page 7-146.
7.13 String literals on page 7-157.
7.19 Unary operators on page 7-163.
Related references
7.22 String manipulation operators on page 7-167.
14.62 SETA, SETL, and SETS on page 14-842.
Examples
abc SETS "this string contains only one "" double quote"
Related references
3.1 Syntax of source lines in assembly language on page 3-58.
9.51 --no_esc on page 9-271.
Example
a SETA 256*256 ; 256*256 is a numeric expression
MOV r1,#(a*22) ; (a*22) is a numeric expression
Related concepts
7.2 Variables on page 7-146.
7.3 Numeric constants on page 7-147.
7.20 Binary operators on page 7-165.
Related references
7.15 Syntax of numeric literals on page 7-159.
14.62 SETA, SETL, and SETS on page 14-842.
Examples
a SETA 34906
addr DCD 0xA10E
LDR r4,=&1000000F
DCD 2_11001010
c3 SETA 8_74007
DCQ 0x0123456789abcdef
LDR r1,='A' ; pseudo-instruction loading 65 into r1
ADD r3,r2,#'\'' ; add 39 to contents of r2, result to r3
Related concepts
7.3 Numeric constants on page 7-147.
Examples
DCFD 1E308,-4E-100
DCFS 1.0
DCFS 0.02
DCFD 3.725e15
DCFS 0x7FC00000 ; Quiet NaN
DCFD &FFF0000000000000 ; Minus infinity
Related concepts
7.3 Numeric constants on page 7-147.
Related references
7.15 Syntax of numeric literals on page 7-159.
Related references
7.26 Boolean operators on page 7-171.
7.25 Relational operators on page 7-170.
Related concepts
7.13 String literals on page 7-157.
Related references
7.15 Syntax of numeric literals on page 7-159.
:LOWERCASE: :LOWERCASE:string Returns the given string, with all uppercase characters converted to
lowercase.
:REVERSE_CC: :REVERSE_CC:cond_code Returns the inverse of the condition code in cond_code, or an error if
cond_code does not contain a valid condition code.
:UPPERCASE: :UPPERCASE:string Returns the given string, with all lowercase characters converted to
uppercase.
The following table lists the unary operators that return numeric values:
+ and - +A Unary plus. Unary minus. + and – can act on numeric and PC-relative
expressions.
-A
:CC_ENCODING: :CC_ENCODING:cond_code Returns the numeric value of the condition code in cond_code, or an
error if cond_code does not contain a valid condition code.
Table 7-2 Unary operators that return numeric or logical values (continued)
Related concepts
7.20 Binary operators on page 7-165.
Note
The order of precedence is not the same as in C.
Related concepts
7.28 Difference between operator precedence in assembly language and C on page 7-173.
Related references
7.21 Multiplicative operators on page 7-166.
7.22 String manipulation operators on page 7-167.
7.23 Shift operators on page 7-168.
7.24 Addition, subtraction, and logical operators on page 7-169.
7.25 Relational operators on page 7-170.
7.26 Boolean operators on page 7-171.
* A*B Multiply
/ A/B Divide
You can use the :MOD: operator on PC-relative expressions to ensure code is aligned correctly.
These alignment checks have the form PC-relative:MOD:Constant. For example:
AREA x,CODE
ASSERT ({PC}:MOD:4) == 0
DCB 1
y DCB 2
ASSERT (y:MOD:4) == 1
ASSERT ({PC}:MOD:4) == 2
END
Related concepts
7.20 Binary operators on page 7-165.
7.5 Register-relative and PC-relative expressions on page 7-149.
7.14 Numeric expressions on page 7-158.
Related references
7.15 Syntax of numeric literals on page 7-159.
Related concepts
7.12 String expressions on page 7-156.
7.14 Numeric expressions on page 7-158.
Note
SHR is a logical shift and does not propagate the sign bit.
Related concepts
7.20 Binary operators on page 7-165.
+ A+B Add A to B
Related concepts
7.20 Binary operators on page 7-165.
= == A=B A equal to B
Related concepts
7.20 Binary operators on page 7-165.
Related concepts
7.20 Binary operators on page 7-165.
Related concepts
7.19 Unary operators on page 7-163.
7.20 Binary operators on page 7-165.
7.28 Difference between operator precedence in assembly language and C on page 7-173.
Related references
7.21 Multiplicative operators on page 7-166.
7.22 String manipulation operators on page 7-167.
7.23 Shift operators on page 7-168.
7.24 Addition, subtraction, and logical operators on page 7-169.
7.25 Relational operators on page 7-170.
7.26 Boolean operators on page 7-171.
The following table shows the order of precedence of operators in assembly language.
In this table:
• The highest precedence operators are at the top of the list.
• The highest precedence operators are evaluated first.
• Operators of equal precedence are evaluated from left to right.
C precedence
unary operators
* / %
+ - (as binary operators)
<< >>
< <= > >=
== !=
C precedence
&
^
|
&&
||
Related concepts
7.20 Binary operators on page 7-165.
Related references
7.27 Operator precedence on page 7-172.
Related concepts
8.2 Half-precision extension on page 8-178.
8.3 Fused Multiply-Add extension on page 8-179.
8.22 VFP vector mode on page 8-199.
Related information
Floating-point support.
Further reading.
Related concepts
8.1 Architecture support for NEON and VFP on page 8-177.
Related concepts
8.1 Architecture support for NEON and VFP on page 8-177.
Note
The following versions of VFP use sixteen double precision registers, D0-D15.
• VFPv2.
• VFPv3-D16.
• VFPv4-D16.
NEON technology uses thirty-two double precision registers, so if your processor has both NEON
and VFP, the VFP implementation must use thirty-two double precision registers.
The aliased views enable half-precision, single-precision, double-precision values, and NEON
vectors to coexist in different non-overlapped registers at the same time.
You can also use the same overlapped registers to store half-precision, single-precision, and
double-precision values, and NEON vectors at different times.
Do not attempt to use overlapped 32-bit and 64-bit, or 128-bit registers at the same time because it
creates meaningless results.
S0
D0
S1
Q0
S2
D1
S3
S4
D2
S5
Q1
S6
D3
S7
S28
D14
S29
Q7
S30
D15
S31
D16
Q8
D17
... ...
D30
Q15
D31
Related concepts
8.5 NEON views of the register bank on page 8-182.
8.6 VFP views of the extension register bank on page 8-183.
Related concepts
8.4 Extension register bank mapping on page 8-180.
8.6 VFP views of the extension register bank on page 8-183.
Related concepts
8.4 Extension register bank mapping on page 8-180.
8.5 NEON views of the register bank on page 8-182.
Related references
12.56 VLDR pseudo-instruction on page 12-657.
12.68 VMOV (floating-point) on page 12-669.
12.69 VMOV (immediate) on page 12-670.
Related references
5.6 Comparison of condition code meanings on page 5-111.
10.8 Condition codes on page 10-317.
Related concepts
8.18 Flush-to-zero mode on page 8-195.
Related references
12 NEON and VFP Instructions on page 12-592.
Related information
ARM Architecture Reference Manual.
Further reading.
The following table shows the data type specifiers available in VFP instructions:
The data type of the second (or only) operand is specified in the instruction.
Note
• Most instructions have a restricted range of permitted data types. See the instruction pages for
details. However, the data type description is flexible:
— If the description specifies I, you can also use S or U data types.
— If only the data size is specified, you can specify a type (I, S, U, P or F).
— If no data type is specified, you can specify a data type.
• The F16 data type is only available on systems that implement the half-precision architecture
extension.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
Related concepts
8.14 NEON scalars on page 8-191.
8.4 Extension register bank mapping on page 8-180.
8.15 Extended notation on page 8-192.
8.10 NEON and VFP data types on page 8-187.
8.12 Normal, long, wide, and narrow NEON operation on page 8-189.
Related concepts
8.11 NEON vectors on page 8-188.
Related references
10.7 Saturating instructions on page 10-316.
Related concepts
8.11 NEON vectors on page 8-188.
8.4 Extension register bank mapping on page 8-180.
Related concepts
8.11 NEON vectors on page 8-188.
8.10 NEON and VFP data types on page 8-187.
8.14 NEON scalars on page 8-191.
Related references
14.55 QN, DN, and SN on page 14-833.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related concepts
4.19 The Read-Modify-Write operation on page 4-92.
Related information
ARM Architecture Reference Manual.
Further reading.
Related concepts
8.20 The effects of using flush-to-zero mode on page 8-197.
Related references
8.19 When to use flush-to-zero mode on page 8-196.
8.21 Operations not affected by flush-to-zero mode on page 8-198.
Related concepts
8.18 Flush-to-zero mode on page 8-195.
8.20 The effects of using flush-to-zero mode on page 8-197.
• If the result of a double-precision floating-point operation, before rounding, is in the range –2–
1022 to +2–1022, it is replaced by 0.
Related concepts
8.18 Flush-to-zero mode on page 8-195.
Related references
8.21 Operations not affected by flush-to-zero mode on page 8-198.
Related concepts
8.18 Flush-to-zero mode on page 8-195.
8.20 The effects of using flush-to-zero mode on page 8-197.
Related references
12.8 VABS on page 12-606.
12.9 VABS (floating-point) on page 12-607.
12.43 VDUP on page 12-641.
12.53 VLDM on page 12-654.
12.54 VLDR on page 12-655.
12.70 VMOV (register) on page 12-671.
12.71 VMOV (between one ARM register and single precision VFP) on page 12-672.
12.72 VMOV (between two ARM registers and an extension register) on page 12-673.
12.73 VMOV (between an ARM register and a NEON scalar) on page 12-674.
12.145 VSWP on page 12-749.
Note
ARM deprecates the use of VFP vector mode.
Related concepts
8.1 Architecture support for NEON and VFP on page 8-177.
8.23 Vectors in the VFP extension register bank on page 8-200.
Related information
ARM Architecture Reference Manual.
In VFPv3 and VFPv3-FP16, the VFP extension register bank can be viewed as a collection of:
• Four banks of single-precision registers, s0 to s7, s8 to s15, s16 to s23, and s24 to s31.
• Eight banks of double-precision registers, d0 to d3, d4 to d7, d8 to d11, d12 to d15, d16 to d19,
d20 to d23, d24 to d27, and d28 to d31.
• Any combination of single-precision and double-precision banks.
s0s1s2s3s4s5s6s7s8 s31
... ...
A vector, in a VFP instruction, can use up to eight single-precision registers, or four double-
precision registers, from the same bank. The number of registers used by a vector is controlled by
the LEN bits in the FPSCR.
Note
The value of the LEN bits is not a sufficient condition to perform vector operations using VFP.
Whether a VFP operation is scalar, vector or mixed depends on which bank the specified operand
and destination registers are in.
A vector can start from any register and wraps around to the beginning of the bank. The first
register used by an operand vector is the register that is specified as the operand in the individual
VFP instructions. The first register used by the destination vector is the register that is specified as
the destination in the individual VFP instructions.
Related concepts
8.24 VFP vector wrap-around on page 8-202.
8.25 VFP vector stride on page 8-203.
8.26 Restriction on vector length on page 8-204.
8.27 Control of scalar, vector, and mixed operations on page 8-205.
Related information
ARM Architecture Reference Manual.
Related concepts
8.23 Vectors in the VFP extension register bank on page 8-200.
8.25 VFP vector stride on page 8-203.
8.26 Restriction on vector length on page 8-204.
Related information
ARM Architecture Reference Manual.
Related concepts
8.23 Vectors in the VFP extension register bank on page 8-200.
8.24 VFP vector wrap-around on page 8-202.
8.26 Restriction on vector length on page 8-204.
Related information
ARM Architecture Reference Manual.
Related concepts
8.23 Vectors in the VFP extension register bank on page 8-200.
8.24 VFP vector wrap-around on page 8-202.
Related information
ARM Architecture Reference Manual.
Op Fd,Fn,Fm
Op Fd,Fm
where:
Op
is the VFP instruction.
Fd
is the destination register.
Fn
is an operand register.
Fm
is the only or second operand register.
the behavior of the operation is as follows:
• If Fd is in the first or fifth bank of registers then the operation is scalar.
• If Fm is in the first or fifth bank of registers, but Fd is not, then the operation is mixed.
• If neither Fd nor Fm are in the first or fifth bank of registers, the operation is vector.
In scalar operations, Op acts on the value in Fm, and the value in Fn if present. The result is placed
in Fd.
In vector operations, Op acts on the values in the vector starting at Fm, together with the values in
the vector starting at Fn if present. The results are placed in the vector starting at Fd.
In mixed operations, with a single operand, Op acts on the single value in Fm and LEN copies of
the result are placed in the vector starting at Fd.
In mixed operations, with two operands, Op acts on the single value in Fm, together with the values
in the vector starting at Fn. The results are placed in the vector starting at Fd.
Related concepts
8.23 Vectors in the VFP extension register bank on page 8-200.
8.24 VFP vector wrap-around on page 8-202.
8.25 VFP vector stride on page 8-203.
8.26 Restriction on vector length on page 8-204.
Related information
ARM Architecture Reference Manual.
Related concepts
8.29 Pre-UAL VFP syntax and mnemonics on page 8-207.
Related references
8.31 VFPASSERT SCALAR on page 8-210.
8.32 VFPASSERT VECTOR on page 8-211.
8.30 Vector notation on page 8-209.
a The immediate in VMOV (immediate) is the floating-point number you want to load. The immediate in FCONST is the
number encoded in the instruction to produce the floating-point number you want to load.
Related references
8.31 VFPASSERT SCALAR on page 8-210.
8.32 VFPASSERT VECTOR on page 8-211.
14.55 QN, DN, and SN on page 14-833.
Syntax
VFPASSERT SCALAR
Usage
Use the VFPASSERT SCALAR directive to mark the end of any block of code where the VFP mode
is VECTOR.
Place the VFPASSERT SCALAR directive immediately after the instruction where the change
occurs. This is usually an FMXR instruction, but might be a BL instruction.
If a function expects VFP to be in vector mode on exit, place a VFPASSERT SCALAR directive
immediately after the last instruction. Such a function would not be AAPCS compliant.
Note
This directive does not generate any code. It is only an assertion by the programmer. The
assembler produces error messages if any such assertions are inconsistent with each other, or with
any vector notation in VFP data processing instructions.
The assembler faults vector notation in VFP data processing instructions following a VFPASSERT
SCALAR directive, even if the vector length is 1.
Example
VFPASSERT SCALAR ; scalar mode
faddd d4, d4, d0 ; okay
fadds s4<3>, s8<3>, s0 ; ERROR, vectors in scalar mode
fabss s24<1>, s28<1> ; ERROR, vectors in scalar mode
; (even though length==1)
Related references
8.30 Vector notation on page 8-209.
8.32 VFPASSERT VECTOR on page 8-211.
Related information
Procedure Call Standard for the ARM Architecture.
Syntax
VFPASSERT VECTOR{<{n{:s}}>}
where:
n
is the vector length, 1-8.
s
is the vector stride, 1-2.
Usage
Use the VFPASSERT VECTOR directive to mark the start of a block of instructions where the VFP
mode is VECTOR, and to mark changes in the length or stride of vectors.
Place the VFPASSERT VECTOR directive immediately after the instruction where the change
occurs. This is usually an FMXR instruction, but might be a BL instruction.
If a function expects VFP to be in vector mode on entry, place a VFPASSERT VECTOR directive
immediately before the first instruction. Such a function would not be AAPCS compliant.
Note
This directive does not generate any code. It is only an assertion by the programmer. The
assembler produces error messages if any such assertions are inconsistent with each other, or with
any vector notation in VFP data processing instructions.
Example
VMRS r10,FPSCR ; UAL mnemonic - could be FMRX instead.
BIC r10,r10,#0x00370000
ORR r10,r10,#0x00020000 ; set length = 3, stride = 1
VMSR FPSCR,r10
VFPASSERT VECTOR ; assert vector mode, unspecified length
; and stride
faddd d4, d4, d0 ; ERROR, scalars in vector mode
fadds s16<3>, s8<3>, s0 ; okay
fabss s24<1>, s28<1> ; wrong length, but not faulted
; (unspecified)
VMRS r10,FPSCR
BIC r10,r10,#0x00370000
ORR r10,r10,#0x00030000 ; set length = 4, stride = 1
VMSR FPSCR,r10
VFPASSERT VECTOR<4> ; assert vector mode, length 4, stride 1
fadds s24<4>, s8<4>, s0 ; okay
fabss s24<2>, s24<2> ; ERROR, wrong length
VMRS r10,FPSCR
BIC r10,r10,#0x00370000
ORR r10,r10,#0x00130000 ; set length = 4, stride = 2
VMSR FPSCR,r10
VFPASSERT VECTOR<4:2> ; assert vector mode, length 4, stride 2
fadds s8<4>, s16<4>, s0 ; ERROR, wrong stride because omitting
; stride causes a default stride of 1.
fabss s16<4:2>, s28<4:2> ; okay
fadds s8<>, s16<>, s2 ; okay (s8 and s16 both have
; length 4 and stride 2. s2 is scalar.)
Related references
8.30 Vector notation on page 8-209.
8.31 VFPASSERT SCALAR on page 8-210.
Related information
Procedure Call Standard for the ARM Architecture.
9.1 --16
Instructs the assembler to interpret instructions as Thumb instructions using the pre-UAL Thumb
syntax.
This option is equivalent to a CODE16 directive at the head of the source file. Use the --thumb
option to specify Thumb instructions using the UAL syntax.
Related references
9.66 --thumb on page 9-286.
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
9.2 --32
A synonym for the --arm command-line option.
Related references
9.4 --arm on page 9-220.
9.3 --apcs=qualifier…qualifier
Controls interworking and position independence when generating code.
Syntax
--apcs=qualifier...qualifier
Where qualifier...qualifier denotes a list of qualifiers. There must be:
• At least one qualifier present.
• No spaces or commas separating individual qualifiers in the list.
Each instance of qualifier must be one of:
none
Specifies that the input file does not use AAPCS. AAPCS registers are not set up. Other
qualifiers are not permitted if you use none.
/interwork, /nointerwork
/interwork specifies that the code in the input file can interwork between ARM and
Thumb safely. The default is /nointerwork.
/inter, /nointer
Are synonyms for /interwork and /nointerwork.
/ropi, /noropi
/ropi specifies that the code in the input file is Read-Only Position-Independent
(ROPI). The default is /noropi.
/pic, /nopic
Are synonyms for /ropi and /noropi.
/rwpi, /norwpi
/rwpi specifies that the code in the input file is Read-Write Position-Independent
(RWPI). The default is /norwpi.
/pid, /nopid
Are synonyms for /rwpi and /norwpi.
/fpic, /nofpic
/fpic specifies that the code in the input file is read-only independent and references to
addresses are suitable for use in a Linux shared object. The default is /nofpic.
/hardfp, /softfp
Requests hardware or software floating-point linkage. This enables the procedure call
standard to be specified separately from the version of the floating-point hardware
available through the --fpu option. It is still possible to specify the procedure call
standard by using the --fpu option, but ARM recommends you use --apcs. If floating-
point support is not permitted (for example, because --fpu=none is specified, or
because of other means), then /hardfp and /softfp are ignored. If floating-point
support is permitted and the softfp calling convention is used (--fpu=softvfp or --
fpu=softvfp+vfp...), then /hardfp gives an error.
Usage
This option specifies whether you are using the Procedure Call Standard for the ARM
Architecture (AAPCS). It can also specify some attributes of code sections.
The AAPCS forms part of the Base Standard Application Binary Interface for the ARM
Architecture (BSABI) specification. By writing code that adheres to the AAPCS, you can ensure
that separately compiled and assembled modules can work together.
Note
AAPCS qualifiers do not affect the code produced by the assembler. They are an assertion by the
programmer that the code in the input file complies with a particular variant of AAPCS. They
cause attributes to be set in the object file produced by the assembler. The linker uses these
attributes to check compatibility of files, and to select appropriate library variants.
Example
Related information
Procedure Call Standard for the ARM Architecture.
--apcs=qualifier...qualifier compiler option.
Interworking ARM and Thumb.
Application Binary Interface (ABI) for the ARM Architecture.
9.4 --arm
Targets the ARM instruction set. The assembler is permitted to generate both ARM and Thumb
code, but recognizes that ARM code is preferred.
This option instructs the assembler to interpret instructions as ARM instructions. It does not,
however, guarantee ARM-only code in the object file. This is the default. Using this option is
equivalent to specifying the ARM or CODE32 directive at the start of the source file.
Related references
9.2 --32 on page 9-217.
9.5 --arm_only on page 9-221.
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
9.5 --arm_only
Enforces ARM-only code. The assembler behaves as if Thumb is absent from the target
architecture.
This option instructs the assembler to only generate ARM code. This is similar to --arm but also
has the property that the assembler does not permit the generation of any Thumb code.
Related references
9.4 --arm on page 9-220.
9.6 --bi
A synonym for the --bigend command-line option.
Related references
9.7 --bigend on page 9-223.
9.46 --littleend on page 9-266.
9.7 --bigend
Generates code suitable for an ARM processor using big-endian memory.
The default is --littleend.
Related references
9.46 --littleend on page 9-266.
Related references
9.20 --diag_error=tag[,tag,…] on page 9-239.
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.9 --checkreglist
Instructs the assembler to check RLIST, LDM, and STM register lists to ensure that all registers are
provided in increasing register number order.
When this option is used, the assembler gives a warning if the registers are not listed in order.
This option is deprecated. Use --diag_warning 1206 instead.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.10 --compatible=name
Generates code that is compatible with multiple target architectures or processors.
Syntax
--compatible=name
Where name is the name of a target processor or architecture, or NONE.
Usage
When you specify a processor or architecture name using --compatible, valid values of name
for both the --cpu and --compatible options are restricted to those shown in the following
table and must not be from the same group:
Group 1 ARM7TDMI, 4T
Group 2 Cortex-M0, Cortex-M1, Cortex-M3, Cortex-M4, 7-M, 6-M, 6S-M, SC300, SC000
Specify --compatible=NONE to turn off all previous instances of the option on the command
line.
Example
Related references
9.14 --cpu=name on page 9-230.
9.11 --cpreproc
Instructs the assembler to call armcc to preprocess the input file before assembling it.
Related concepts
6.17 Using the C preprocessor on page 6-139.
Related references
9.12 --cpreproc_opts=options on page 9-228.
9.12 --cpreproc_opts=options
Enables the assembler to pass options to the compiler when using the C preprocessor.
Syntax
--cpreproc_opts=options
Where options is a comma-separated list of options and their values.
Example
Related concepts
6.17 Using the C preprocessor on page 6-139.
Related references
9.11 --cpreproc on page 9-227.
9.13 --cpu=list
Lists the architecture and processor names that are supported by the --cpu=name option.
Syntax
--cpu=list
Related references
9.14 --cpu=name on page 9-230.
9.14 --cpu=name
Enables code generation for the selected ARM processor or architecture.
Syntax
--cpu=name
Where name is the name of a processor or architecture:
• If name is the name of a processor, enter it as shown on ARM data sheets, for example,
ARM7TDMI, ARM1176JZ-S, MPCore.
• If name is the name of an architecture, it must belong to the list of architectures shown in the
following table.
Processor and architecture names are not case-sensitive.
Wildcard characters are not accepted.
Note
armasm cannot generate Java bytecodes.
Note
• ARMv7 is not an actual ARM architecture. --cpu=7 denotes the features that are common to
the ARMv7-A, ARMv7-R, and ARMv7-M architectures. By definition, any given feature used
with --cpu=7 exists on the ARMv7-A, ARMv7-R, and ARMv7-M architectures.
• 7-A.security is not an actual ARM architecture, but rather, refers to 7-A plus Security
Extensions.
Default
armasm assumes --cpu=ARM7TDMI if you do not specify a --cpu option.
To obtain a full list of architectures and processors, use the --cpu=list option.
Usage
The following general points apply to processor and architecture options:
Processors
• Selecting the processor selects the appropriate architecture, Floating-Point Unit
(FPU), and memory organization.
• The supported --cpu values include all current ARM product names or architecture
versions.
Other ARM architecture-based processors, such as the Marvell Feroceon and the
Marvell XScale, are also supported.
• If you specify a processor for the --cpu option, the generated code is optimized for
that processor. This enables the assembler to use specific coprocessors or instruction
scheduling for optimum performance.
Architectures
• If you specify an architecture name for the --cpu option, the generated code can run
on any processor supporting that architecture. For example, --cpu=5TE produces
code that can be used by the ARM926EJ-S® processor.
FPU
• Some specifications of --cpu imply an --fpu selection.
For example, when building with the --arm option, --cpu=ARM1136JF-S implies
--fpu=vfpv2. Similarly, --cpu=Cortex-R4F implies --fpu=vfpv3_d16.
Note
Any explicit FPU, set with --fpu on the command line, overrides an implicit FPU.
Note
Specifying the target processor or architecture might make the generated object code
incompatible with other ARM processors. For example, code generated for
architecture ARMv6 might not run on an ARM920T processor, if the generated object
code includes instructions specific to ARMv6. Therefore, you must choose the lowest
common denominator processor suited to your purpose.
• If you are building for mixed ARM/Thumb systems for processors that support
ARMv4T or ARMv5T, then you must specify the interworking option --apcs=/
interwork. By default, this is enabled for processors that support ARMv5T or
above.
• If you build for Thumb, that is with the --thumb option on the command line, the
assembler generates as much of the code as possible using the Thumb instruction set.
However, the assembler might generate ARM code for some parts of the compilation.
For example, if you are generating code for a 16-bit Thumb processor and using VFP,
any function containing floating-point operations is compiled for ARM.
• If the architecture only supports Thumb, you do not have to specify --thumb on the
command line. For example, if building for ARMv7-M with --cpu=7-M, you do not
have to specify --thumb on the command line, because ARMv7-M only supports
Thumb. Similarly, ARMv6-M and other Thumb-only architectures.
Restrictions
You cannot specify both a processor and an architecture on the same command-line.
Example
Related references
9.10 --compatible=name on page 9-226.
9.13 --cpu=list on page 9-229.
9.69 --unsafe on page 9-289.
Related information
ARM Architecture Reference Manual.
9.15 --debug
Instructs the assembler to generate DWARF debug tables.
--debug is a synonym for -g. The default is DWARF 3.
Note
Local symbols are not preserved with --debug. You must specify --keep if you want to
preserve the local symbols to aid debugging.
Related references
9.26 --dwarf2 on page 9-245.
9.27 --dwarf3 on page 9-246.
9.36 -g on page 9-256.
9.39 --keep on page 9-259.
9.16 --depend=dependfile
Writes makefile dependency lines to a file.
Source file dependency lists are suitable for use with make utilities.
Related references
9.49 --md on page 9-269.
9.17 --depend_format=string on page 9-236.
9.17 --depend_format=string
Specifies the format of output dependency files, for compatibility with some UNIX make
programs.
Syntax
--depend_format=string
Where string is one of:
unix
generates dependency file entries using UNIX-style path separators.
unix_escaped
is the same as unix, but escapes spaces with \.
unix_quoted
is the same as unix, but surrounds path names with double quotes.
Related references
9.16 --depend=dependfile on page 9-235.
9.18 --device=list
Lists the device names that are supported by the --device=name option.
Note
This option is deprecated.
Related references
9.19 --device=name on page 9-238.
9.19 --device=name
Selects a specific microcontroller or System-on-Chip (SoC) device.
Note
This option is deprecated.
Related references
9.18 --device=list on page 9-237.
9.14 --cpu=name on page 9-230.
9.20 --diag_error=tag[,tag,…]
Sets diagnostic messages that have a specific tag to Error severity.
Syntax
--diag_error=tag[,tag,…]
Where tag can be:
• A diagnostic message number to set to error severity.
• warning, to treat all warnings as errors.
Usage
Diagnostic messages output by the assembler can be identified by a tag in the form of
{prefix}number, where the prefix is A.
You can specify more than one tag with this option by separating each tag using a comma. You
can specify the optional assembler prefix A before the tag number. If any prefix other than A is
included, the message number is ignored.
The following table shows the meaning of the term severity used in the option descriptions:
Severity Description
Error Errors indicate violations in the syntactic or semantic rules of assembly language. Assembly continues, but
object code is not generated.
Warning Warnings indicate unusual conditions in your code that might indicate a problem. Assembly continues, and
object code is generated unless any problems with an Error severity are detected.
Remark Remarks indicate common, but not recommended, use of assembly language. These diagnostics are not issued
by default. Assembly continues, and object code is generated unless any problems with an Error severity are
detected.
Related references
9.8 --brief_diagnostics, --no_brief_diagnostics on page 9-224.
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.21 --diag_remark=tag[,tag,…] on page 9-240.
9.21 --diag_remark=tag[,tag,…]
Sets diagnostic messages that have a specific tag to Remark severity.
Syntax
--diag_remark=tag[,tag,…]
Where tag is a comma-separated list of diagnostic message numbers.
Usage
Diagnostic messages output by the assembler can be identified by a tag in the form of
{prefix}number, where the prefix is A.
You can specify more than one tag with this option by separating each tag using a comma. You
can specify the optional assembler prefix A before the tag number. If any prefix other than A is
included, the message number is ignored.
Related references
9.20 --diag_error=tag[,tag,…] on page 9-239.
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.22 --diag_style={arm|ide|gnu}
Specifies the display style for diagnostic messages.
Syntax
--diag_style=string
Where string is one of:
arm
Display messages using the ARM compiler style.
ide
Include the line number and character count for any line that is in error. These values are
displayed in parentheses.
gnu
Display messages in the format used by gcc.
Usage
--diag_style=gnu matches the format reported by the GNU Compiler, gcc.
--diag_style=ide matches the format reported by Microsoft Visual Studio.
Choosing the option --diag_style=ide implicitly selects the option --brief_diagnostics.
Explicitly selecting --no_brief_diagnostics on the command line overrides the selection of
--brief_diagnostics implied by --diag_style=ide.
Selecting either the option --diag_style=arm or the option --diag_style=gnu does not
imply any selection of --brief_diagnostics.
Default
The default is --diag_style=arm.
Related references
9.8 --brief_diagnostics, --no_brief_diagnostics on page 9-224.
9.23 --diag_suppress=tag[,tag,…]
Suppresses diagnostic messages that have a specific tag.
Syntax
--diag_suppress=tag[,tag,…]
Where tag can be:
• A diagnostic message number to be suppressed.
• error, to suppress all errors that can be downgraded.
• warning, to suppress all warnings.
Diagnostic messages output by the assembler can be identified by a tag in the form of
{prefix}number, where the prefix is A.
You can specify more than one tag with this option by separating each tag using a comma.
Examples
For example, to suppress the warning messages that have numbers 1293 and 187, use the
following command:
armasm --diag_suppress=1293,187
You can specify the optional assembler prefix A before the tag number. For example:
armasm --diag_suppress=A1293,A187
If any prefix other than A is included, the message number is ignored. Diagnostic message tags
can be cut and pasted directly into a command line.
9.24 --diag_warning=tag[,tag,…]
Sets diagnostic messages that have a specific tag to Warning severity.
Syntax
--diag_warning=tag[,tag,…]
Where tag can be:
• A diagnostic message number to set to warning severity.
• error, to set all errors that can be downgraded to warnings.
Diagnostic messages output by the assembler can be identified by a tag in the form of
{prefix}number, where the prefix is A.
You can specify more than one tag with this option by separating each tag using a comma.You
can specify the optional assembler prefix A before the tag number. If any prefix other than A is
included, the message number is ignored.
Related references
9.20 --diag_error=tag[,tag,…] on page 9-239.
9.21 --diag_remark=tag[,tag,…] on page 9-240.
9.25 --dllexport_all
Controls symbol visibility when building DLLs.
This option gives all exported global symbols STV_PROTECTED visibility in ELF rather than
STV_HIDDEN, unless overridden by source directives.
Related references
14.25 EXPORT or GLOBAL on page 14-796.
9.26 --dwarf2
Uses DWARF 2 debug table format.
This option can be used with --debug, to instruct the assembler to generate DWARF 2 debug
tables.
Related references
9.15 --debug on page 9-234.
9.27 --dwarf3 on page 9-246.
9.27 --dwarf3
Uses DWARF 3 debug table format.
This option can be used with --debug, to instruct the assembler to generate DWARF 3 debug
tables. This is the default if --debug is specified.
Related references
9.15 --debug on page 9-234.
9.26 --dwarf2 on page 9-245.
9.28 --errors=errorfile
Redirects the output of diagnostic messages from stderr to the specified errors file.
AREA |.note.GNU-stack|,ALIGN=0,READONLY,NOALLOC,CODE
Table 9-4 Specifying a command-line option and an AREA directive for GNU-stack sections
Related references
14.6 AREA on page 14-774.
9.30 --execute_only
Adds the EXECONLY AREA attribute to all code sections.
Usage
The EXECONLY AREA attribute causes the linker to treat the section as execute-only.
It is the user's responsibility to ensure that the code in the section is safe to run in execute-only
memory. For example:
• The code must not contain literal pools.
• The code must not attempt to load data from the same, or another, execute-only section.
Restrictions
This option is only supported for the following processors:
• Cortex-M3.
• Cortex-M4.
Related references
14.6 AREA on page 14-774.
Related information
Execute-only memory.
Building applications for execute-only memory.
Related references
9.32 --exceptions_unwind, --no_exceptions_unwind on page 9-251.
14.36 FRAME UNWIND ON on page 14-808.
14.37 FRAME UNWIND OFF on page 14-809.
14.38 FUNCTION or PROC on page 14-810.
14.39 ENDFUNC or ENDP on page 14-812.
Related references
9.31 --exceptions, --no_exceptions on page 9-250.
14.36 FRAME UNWIND ON on page 14-808.
14.37 FRAME UNWIND OFF on page 14-809.
14.38 FUNCTION or PROC on page 14-810.
14.39 ENDFUNC or ENDP on page 14-812.
9.33 --fpmode=model
Specifies floating-point standard conformance and sets library attributes and floating-point
optimizations.
Syntax
--fpmode=model
Where model is one of:
none
Source code is not permitted to use any floating-point type or floating-point instruction.
This option overrides any explicit --fpu=name option.
ieee_full
All facilities, operations, and representations guaranteed by the IEEE standard are
available in single and double-precision. Modes of operation can be selected dynamically
at runtime.
ieee_fixed
IEEE standard with round-to-nearest and no inexact exceptions.
ieee_no_fenv
IEEE standard with round-to-nearest and no exceptions. This mode is compatible with the
Java floating-point arithmetic model.
std
IEEE finite values with denormals flushed to zero, round-to-nearest and no exceptions. It
is C and C++ compatible. This is the default option.
Finite values are as predicted by the IEEE standard. It is not guaranteed that NaNs and
infinities are produced in all circumstances defined by the IEEE model, or that when they
are produced, they have the same sign. Also, it is not guaranteed that the sign of zero is
that predicted by the IEEE model.
fast
Some value altering optimizations, where accuracy is sacrificed to fast execution. This is
not IEEE compatible, and is not standard C.
Note
This does not cause any changes to the code that you write.
Example
Related references
9.35 --fpu=name on page 9-254.
Related information
IEEE Standards Association.
9.34 --fpu=list
Lists the FPU architecture names that are supported by the --fpu=name option.
Examples
armasm --fpu=list
Related references
9.33 --fpmode=model on page 9-252.
9.35 --fpu=name on page 9-254.
9.35 --fpu=name
Specifies the target FPU architecture.
Syntax
--fpu=name
Where name is one of:
none
Selects no floating-point option. No floating-point code is to be used. This produces an
error if your code contains floating-point instructions.
vfpv2
Selects a hardware floating-point unit conforming to architecture VFPv2.
vfpv3
Selects a hardware vector floating-point unit conforming to architecture VFPv3. VFPv3
is backwards compatible with VFPv2 except that VFPv3 cannot trap floating-point
exceptions.
vfpv3_fp16
Selects a hardware vector floating-point unit conforming to architecture VFPv3 that also
provides the half-precision extensions.
vfpv3_d16
Selects a hardware vector floating-point unit conforming to VFPv3-D16 architecture.
vfpv3_d16_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-D16 architecture, that
also provides the half-precision extensions.
vfpv4
Selects a hardware floating-point unit conforming to the VFPv4 architecture.
vfpv4_d16
Selects a hardware floating-point unit conforming to the VFPv4-D16 architecture.
fpv4-sp
Selects a hardware floating-point unit conforming to the single precision variant of the
FPv4 architecture.
softvfp
Selects software floating-point support where floating-point operations are performed by
a floating-point library, fplib. This is the default if you do not specify a --fpu option,
or if you select a CPU that does not have an FPU.
softvfp+vfpv2
Selects a hardware floating-point unit conforming to VFPv2, with software floating-point
linkage. Select this option if you are interworking Thumb code with ARM code on a
system that implements a VFP unit.
softvfp+vfpv3
Selects a hardware vector floating-point unit conforming to VFPv3, with software
floating-point linkage. Select this option if you are interworking Thumb code with ARM
code on a system that implements a VFPv3 unit.
softvfp+vfpv3_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-fp16, with software
floating-point linkage.
softvfp+vfpv3_d16
Selects a hardware vector floating-point unit conforming to VFPv3-D16, with software
floating-point linkage.
softvfp+vfpv3_d16_fp16
Selects a hardware vector floating-point unit conforming to VFPv3-D16-fp16, with
software floating-point linkage.
softvfp+vfpv4
Selects a hardware floating-point unit conforming to FPv4, with software floating-point
linkage.
softvfp+vfpv4_d16
Selects a hardware floating-point unit conforming to VFPv4-D16, with software floating-
point linkage.
softvfp+fpv4-sp
Selects a hardware floating-point unit conforming to FPv4-SP, with software floating-
point linkage.
Usage
If you specify this option, it overrides any implicit FPU option that appears on the command line,
for example, where you use the --cpu option.
Any FPU explicitly selected using the --fpu option always overrides any FPU implicitly selected
using the --cpu option. For example, the option --cpu=ARM1136JF-S --fpu=softvfp
generates code that uses the software floating-point library fplib, even though the choice of CPU
implies the use of architecture VFPv2.
The assembler sets a build attribute corresponding to name in the object file. The linker
determines compatibility between object files, and selection of libraries, accordingly.
To control floating-point linkage without affecting the choice of FPU, you can use --apcs=/
softfp or --apcs=/hardfp.
To obtain a full list of FPU architectures use the --fpu=list option.
Restrictions
The assembler only permits hardware VFP architectures, such as --fpu=vfpv3 or --
fpu=softvfp+vfpv2, to be specified when MRRC and MCRR instructions are supported in the
processor instruction set. MRRC and MCRR instructions are not supported in 4, 4T, 5T and 6-M.
Therefore, the assembler does not allow the use of these CPU architectures with hardware VFP
architectures.
Other than this, the assembler does not check that --cpu and --fpu combinations are valid.
Beyond the scope of the assembler, additional architectural constraints apply. For example,
VFPv3 is not supported with architectures prior to ARMv7. Therefore, the combination of --fpu
and --cpu options permitted by the assembler does not necessarily translate to the actual device
in use.
NEON support is disabled for softvfp.
Default
The default target FPU architecture is derived from use of the --cpu option.
If the CPU specified with --cpu has a VFP coprocessor, the default target FPU architecture is the
VFP architecture for that CPU. For example, the option --cpu ARM1136JF-S implies the option
--fpu vfpv2. If a VFP coprocessor is present, VFP instructions are generated.
Related references
9.33 --fpmode=model on page 9-252.
9.36 -g
Enables the generation of debug tables.
This option is a synonym for --debug.
Related references
9.15 --debug on page 9-234.
9.37 --help
Displays a summary of the main command-line options.
Default
This is the default if you specify armasm without any options or source files.
Related references
9.71 --version_number on page 9-291.
9.73 --vsn on page 9-293.
9.38 -idir{,dir, …}
Adds directories to the source file include path.
Any directories added using this option have to be fully qualified.
Related references
14.42 GET or INCLUDE on page 14-815.
9.39 --keep
Instructs the assembler to keep named local labels in the symbol table of the object file, for use by
the debugger.
Related references
14.47 KEEP on page 14-822.
9.40 --length=n
Sets the listing page length.
Length zero means an unpaged listing. The default is 66 lines.
Related references
9.44 --list=file on page 9-264.
9.41 --li
A synonym for the --littleend command-line option.
Related references
9.46 --littleend on page 9-266.
9.7 --bigend on page 9-223.
9.42 --library_type=lib
Enables the selected library to be used at link time.
Syntax
--library_type=lib
Where lib is one of:
standardlib
Specifies that the full ARM runtime libraries are selected at link time. This is the default.
microlib
Specifies that the C micro-library (microlib) is selected at link time.
Note
This option can be used with the compiler, assembler, or linker when use of the libraries require
more specialized optimizations.
This option can be overridden at link time by providing it to the linker.
Related information
Building an application with microlib.
--library_type=lib compiler option.
9.43 --licretry
If you are using floating licenses, this option makes up to 10 attempts to obtain a license when you
invoke armasm.
Usage
Use this option if your builds are failing to obtain a license from your license server, and only
after you have ruled out any other problems with the network or the license server setup.
It is recommended that you place this option in the ARMCC5_ASMOPT environment variable. In this
way, you do not have to modify your build files.
Related information
Toolchain environment variables.
ARM DS-5 License Management Guide.
9.44 --list=file
Instructs the assembler to output a detailed listing of the assembly language produced by the
assembler to a file.
If - is given as file, the listing is sent to stdout.
Use the following command-line options to control the behavior of --list:
• --no_terse.
• --width.
• --length.
• --xref.
Related references
9.54 --no_terse on page 9-274.
9.74 --width=n on page 9-294.
9.40 --length=n on page 9-260.
9.75 --xref on page 9-295.
14.54 OPT on page 14-831.
9.45 --list=
Instructs the assembler to send the detailed assembly language listing to inputfile.lst.
Note
You can use --list without the equals sign and filename to send the output to inputfile.lst.
However, this syntax is deprecated and the assembler issues a warning. This syntax is to be
removed in a later release. Use --list= instead.
Related references
9.44 --list=file on page 9-264.
9.46 --littleend
Generates code suitable for an ARM processor using little-endian memory.
Related references
9.7 --bigend on page 9-223.
9.47 -m
Instructs the assembler to write source file dependency lists to stdout.
Related references
9.49 --md on page 9-269.
9.48 --maxcache=n
Sets the maximum source cache size in bytes.
The default is 8MB. armasm gives a warning if the size is less than 8MB.
9.49 --md
Creates makefile dependency lists.
This option instructs the assembler to write source file dependency lists to inputfile.d.
Related references
9.47 -m on page 9-267.
9.50 --no_code_gen
Instructs the assembler to exit after pass 1, generating no object file. This option is useful if you
only want to check the syntax of the source code or directives.
9.51 --no_esc
Instructs the assembler to ignore C-style escaped special characters, such as \n and \t.
9.52 --no_hide_all
Gives all exported and imported global symbols STV_DEFAULT visibility in ELF rather than
STV_HIDDEN, unless overridden using source directives.
You can use the following directives to specify an attribute that overrides the implicit symbol
visibility:
• EXPORT.
• EXTERN.
• GLOBAL.
• IMPORT.
Related references
14.25 EXPORT or GLOBAL on page 14-796.
14.44 IMPORT and EXTERN on page 14-818.
9.53 --no_regs
Instructs the assembler not to predefine register names.
This option is deprecated. Use --regnames=none instead.
Related references
9.60 --regnames=none on page 9-280.
9.54 --no_terse
Instructs the assembler to show in the list file the lines of assembly code that it has skipped
because of conditional assembly.
If you do not specify this option, the assembler does not output the skipped assembly code to the
list file.
This option turns off the terse flag. By default the terse flag is on.
Related references
9.44 --list=file on page 9-264.
9.55 --no_warn
Turns off warning messages.
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.56 -o filename
Specifies the name of the output file.
If this option is not used, the assembler creates an object filename in the form
inputfilename.o. This option is case-sensitive.
9.57 --pd
A synonym for the --predefine command-line option.
Related references
9.58 --predefine "directive" on page 9-278.
The assembler also executes a corresponding GBLL, GBLS, or GBLA directive to define the variable
before setting its value.
The variable name is case-sensitive. The variables defined using the command line are global to
the assembler source files specified on the command line.
Related concepts
6.16 Conditional assembly on page 6-138.
Related references
9.57 --pd on page 9-277.
14.41 GBLA, GBLL, and GBLS on page 14-814.
14.43 IF, ELSE, ENDIF, and ELIF on page 14-816.
14.62 SETA, SETL, and SETS on page 14-842.
Note
ARM recommends that you avoid using long and deeply nested file paths, in preference to
minimizing path lengths using the --reduce_paths option.
Note
This option is valid for 32-bit Windows systems only.
Related information
--reduce_paths, --no_reduce_paths compiler option.
9.60 --regnames=none
Instructs the assembler not to predefine register names.
Related references
9.53 --no_regs on page 9-273.
9.61 --regnames=callstd on page 9-281.
9.62 --regnames=all on page 9-282.
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
2.14 Predeclared coprocessor names on page 2-49.
9.61 --regnames=callstd
Defines additional register names based on the AAPCS variant that you are using, as specified by
the --apcs option.
Related references
9.60 --regnames=none on page 9-280.
9.62 --regnames=all on page 9-282.
9.3 --apcs=qualifier…qualifier on page 9-218.
9.62 --regnames=all
Defines all AAPCS registers regardless of the value of --apcs.
Related references
9.60 --regnames=none on page 9-280.
9.61 --regnames=callstd on page 9-281.
9.3 --apcs=qualifier…qualifier on page 9-218.
9.63 --report-if-not-wysiwyg
Instructs the assembler to report when it outputs an encoding that was not directly requested in the
source code.
This can happen when the assembler:
• Uses a pseudo-instruction that is not available in other assemblers, for example MOV32.
• Outputs an encoding that does not directly match the instruction mnemonic, for example if the
assembler outputs the MVN encoding when assembling the MOV instruction.
• Inserts additional instructions where necessary for instruction syntax semantics, for example
the assembler can insert a missing IT instruction before a conditional Thumb instruction.
9.64 --show_cmdline
Outputs the command line used by the assembler.
Usage
Shows the command line after processing by the assembler, and can be useful to check:
• The command line a build system is using.
• How the assembler is interpreting the supplied command line, for example, the ordering of
command-line options.
The commands are shown normalized, and the contents of any via files are expanded.
The output is sent to the standard error stream (stderr).
Related references
9.72 --via=filename on page 9-292.
9.65 --split_ldm
Instructs the assembler to fault LDM and STM instructions with a large number of registers.
Note
This option is deprecated.
This option faults LDM instructions if the maximum number of registers transferred exceeds:
• Five, for LDMs that do not load the PC.
• Four, for LDMs that load the PC.
This option faults STM instructions if the maximum number of registers transferred exceeds 5.
Avoiding large multiple register transfers can reduce interrupt latency on ARM systems that:
• Do not have a cache or a write buffer (for example, a cacheless ARM7TDMI).
• Use zero wait-state, 32-bit memory.
Also, avoiding large multiple register transfers:
• Always increases code size.
• Has no significant benefit for cached systems or processors with a write buffer.
• Has no benefit for systems without zero wait-state memory, or for systems with slow
peripheral devices. Interrupt latency in such systems is determined by the number of cycles
required for the slowest memory or peripheral access. This is typically much greater than the
latency introduced by multiple register transfers.
Related references
10.40 LDM on page 10-370.
9.66 --thumb
Targets the Thumb instruction set.
This option instructs the assembler to interpret instructions as Thumb instructions, using the UAL
syntax. This is equivalent to a THUMB directive at the start of the source file.
Related references
9.4 --arm on page 9-220.
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
9.67 --thumbx
Targets the ThumbEE instruction set.
This option instructs the assembler to interpret instructions as ThumbEE instructions, using the
UAL syntax. This is equivalent to a THUMBX directive at the start of the source file.
Related references
14.7 ARM, THUMB, THUMBX, CODE16, and CODE32 on page 14-778.
9.69 --unsafe
Enables instructions for other architectures to be assembled without error.
It downgrades error messages to corresponding warning messages. It also suppresses warnings
about operator precedence.
Related concepts
7.20 Binary operators on page 7-165.
Related references
9.20 --diag_error=tag[,tag,…] on page 9-239.
9.24 --diag_warning=tag[,tag,…] on page 9-243.
9.70 --untyped_local_labels
Causes the assembler not to set the Thumb bit for the address of a numeric local label referenced
in an LDR pseudo instruction.
When this option is not used, if you reference a numeric local label in an LDR pseudo-instruction,
and the label is in Thumb code, then the assembler sets the Thumb bit (bit 0) of the address. You
can then use the address as the target for a BX or BLX instruction.
If you require the actual address of the numeric local label, without the Thumb bit set, then use
this option.
Note
When using this option, if you use the address in a branch (register) instruction, the assembler
treats it as an ARM code address, causing the branch to arrive in ARM state, meaning it would
interpret this code as ARM instructions.
Example
THUMB
...
1
...
LDR r0,=%B1 ; r0 contains the address of numeric local label "1".
; Thumb bit is not set if --untyped_local_labels was
; used.
...
Related concepts
7.10 Numeric local labels on page 7-154.
Related references
10.45 LDR pseudo-instruction on page 10-385.
10.16 B on page 10-333.
9.71 --version_number
Displays the version of armasm you are using.
Usage
The assembler displays the version number in the format nnnbbbb, where:
• nnn is the version number.
• bbbb is the build number.
Examples
Version 5.01 build 0019 is displayed as 5010019.
9.72 --via=filename
Reads an additional list of input filenames and assembler options from filename.
Syntax
--via=filename
Where filename is the name of a via file containing options to be included on the command line.
Usage
You can enter multiple --via options on the assembler command line. The --via options can
also be included within a via file.
Related concepts
6.3 Overview of via files on page 6-121.
Related references
6.4 Via file syntax rules on page 6-122.
9.73 --vsn
Displays the version information and the license details.
Examples
Example output:
9.74 --width=n
Sets the listing page width.
The default is 79 characters.
Related references
9.44 --list=file on page 9-264.
9.75 --xref
Instructs the assembler to list cross-referencing information on symbols, including where they
were defined and where they were used, both inside and outside macros.
The default is off.
Related references
9.44 --list=file on page 9-264.
Describes the ARM and Thumb instructions supported by the ARM assembler, armasm.
Some instruction descriptions have an Architectures section. Instructions that do not have this
section are available in all versions of the ARM instruction set, and all versions of the Thumb
instruction set.
It contains the following:
• 10.1 ARM and Thumb instruction summary on page 10-301.
• 10.2 Instruction width specifiers on page 10-309.
• 10.3 Flexible second operand (Operand2) on page 10-310.
• 10.4 Syntax of Operand2 as a constant on page 10-311.
• 10.5 Syntax of Operand2 as a register with optional shift on page 10-312.
• 10.6 Shift operations on page 10-313.
• 10.7 Saturating instructions on page 10-316.
• 10.8 Condition codes on page 10-317.
• 10.9 ADC on page 10-318.
• 10.10 ADD on page 10-320.
• 10.11 ADR (PC-relative) on page 10-323.
• 10.12 ADR (register-relative) on page 10-325.
• 10.13 ADRL pseudo-instruction on page 10-327.
• 10.14 AND on page 10-329.
• 10.15 ASR on page 10-331.
• 10.16 B on page 10-333.
• 10.17 BFC on page 10-335.
Entries in the Architecture column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5
The ARMv5T*, ARMv6*, and ARMv7 architectures.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
6
The ARMv6* and ARMv7 architectures.
6M
The ARMv6-M and ARMv7 architectures.
x6M
Not available in the ARMv6-M architecture.
7
The ARMv7 architectures.
7M
The ARMv7-M architecture, including ARMv7E-M implementations.
x7M
Not available in the ARMv6-M or ARMv7-M architecture, or any ARMv7E-M
implementation.
7EM
ARMv7E-M implementations but not in the ARMv7-M or ARMv6-M architecture.
7R
The ARMv7-R architecture.
7MP
The ARMv7 architectures that implement the Multiprocessing Extensions.
7VE
The ARMv7 architectures that implement the Virtualization Extensions.
J
The ARMv5TEJ, ARMv6*, and ARMv7 architectures.
K
The ARMv6K, and ARMv7 architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
XScale
XScale versions of the ARM architecture.
Z
If Security Extensions are implemented.
Related concepts
10.6 Shift operations on page 10-313.
Related references
10.4 Syntax of Operand2 as a constant on page 10-311.
10.5 Syntax of Operand2 as a register with optional shift on page 10-312.
Syntax
#constant
where constant is an expression evaluating to a numeric value.
Usage
In ARM instructions, constant can have any value that can be produced by rotating an 8-bit
value right by any even number of bits within a 32-bit word.
In Thumb instructions, constant can be:
• Any constant that can be produced by shifting an 8-bit value left by any number of bits within
a 32-bit word.
• Any constant of the form 0x00XY00XY.
• Any constant of the form 0xXY00XY00.
• Any constant of the form 0xXYXYXYXY.
Note
In these constants, X and Y are hexadecimal digits.
In addition, in a small number of instructions, constant can take a wider range of values. These
are listed in the individual instruction descriptions.
When an Operand2 constant is used with the instructions MOVS, MVNS, ANDS, ORRS, ORNS, EORS,
BICS, TEQ or TST, the carry flag is updated to bit[31] of the constant, if the constant is greater
than 255 and can be produced by shifting an 8-bit value. These instructions do not affect the carry
flag if Operand2 is any other constant.
Instruction substitution
If the value of an Operand2 constant is not available, but its logical inverse or negation is
available, then the assembler produces an equivalent instruction and inverts or negates the
constant.
For example, an assembler might assemble the instruction CMP Rd, #0xFFFFFFFE as the
equivalent instruction CMN Rd, #0x2.
Be aware of this when comparing disassembly listings with source code.
You can use the --diag_warning 1645 assembler command line option to check when an
instruction substitution occurs.
Related concepts
10.6 Shift operations on page 10-313.
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.5 Syntax of Operand2 as a register with optional shift on page 10-312.
Syntax
Rm {, shift}
where:
Rm
is the register holding the data for the second operand.
shift
is an optional constant or register-controlled shift to be applied to Rm. It can be one of:
ASR #n
arithmetic shift right n bits, 1 ≤ n ≤ 32.
LSL #n
logical shift left n bits, 1 ≤ n ≤ 31.
LSR #n
logical shift right n bits, 1 ≤ n ≤ 32.
ROR #n
rotate right n bits, 1 ≤ n ≤ 31.
RRX
rotate right one bit, with extend.
type Rs
register-controlled shift is available in ARM code only, where:
type
is one of ASR, LSL, LSR, ROR.
Rs
is a register supplying the shift amount, and only the least significant
byte is used.
-
if omitted, no shift occurs, equivalent to LSL #0.
Usage
If you omit the shift, or specify LSL #0, the instruction uses the value in Rm.
If you specify a shift, the shift is applied to the value in Rm, and the resulting 32-bit value is used
by the instruction. However, the contents of the register Rm remain unchanged. Specifying a
register with shift also updates the carry flag when used with certain instructions.
Related concepts
10.6 Shift operations on page 10-313.
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.4 Syntax of Operand2 as a constant on page 10-311.
Note
• If n is 32 or more, then all the bits in the result are set to the value of bit[31] of Rm.
• If n is 32 or more and the carry flag is updated, it is updated to the value of bit[31] of Rm.
Carry
Flag
31 54 3 2 1 0
...
Figure 10-1 ASR #3
Note
• If n is 32 or more, then all the bits in the result are cleared to 0.
0 0 0 Carry
Flag
31 5 4 3 2 10
...
Figure 10-2 LSR #3
Note
• If n is 32 or more, then all the bits in the result are cleared to 0.
• If n is 33 or more and the carry flag is updated, it is updated to 0.
0 0 0
31 5 4 3 2 10
Carry
Flag ...
Figure 10-3 LSL #3
Note
• If n is 32, then the value of the result is same as the value in Rm, and if the carry flag is
updated, it is updated to bit[31] of Rm.
• ROR with shift length, n, more than 32 is the same as ROR with shift length n-32.
Carry
Flag
31 5 4 3 2 10
...
Figure 10-4 ROR #3
Carry
Flag
31 1 0
... ...
Figure 10-5 RRX
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.4 Syntax of Operand2 as a constant on page 10-311.
10.5 Syntax of Operand2 as a register with optional shift on page 10-312.
Saturating arithmetic
Saturation means that, for some value of 2n that depends on the instruction:
• For a signed saturating operation, if the full result would be less than –2n, the result returned is
–2n.
• For an unsigned saturating operation, if the full result would be negative, the result returned is
zero.
• If the full result would be greater than 2n – 1, the result returned is 2n – 1.
When any of these occurs, it is called saturation. Some instructions set the Q flag when saturation
occurs.
Note
Saturating instructions do not clear the Q flag when saturation does not occur. To clear the Q flag,
use an MSR instruction.
The Q flag can also be set by two other instructions, but these instructions do not saturate.
Related references
10.76 QADD on page 10-432.
10.83 QSUB on page 10-439.
10.80 QDADD on page 10-436.
10.81 QDSUB on page 10-437.
10.111 SMLAxy on page 10-477.
10.116 SMLAWy on page 10-484.
10.123 SMULxy on page 10-491.
10.125 SMULWy on page 10-493.
10.128 SSAT on page 10-497.
10.176 USAT on page 10-565.
10.65 MSR (general-purpose register to PSR) on page 10-413.
Suffix Meaning
EQ Equal
NE Not equal
CS Carry set (identical to HS)
HS Unsigned higher or same (identical to CS)
CC Carry clear (identical to LO)
LO Unsigned lower (identical to CC)
MI Minus or negative result
PL Positive or zero result
VS Overflow
VC No overflow
HI Unsigned higher
LS Unsigned lower or same
GE Signed greater than or equal
LT Signed less than
GT Signed greater than
LE Signed less than or equal
AL Always (this is the default)
Note
The meanings of the condition codes depend on whether the condition flags were set by a VFP
instruction or by an ARM data processing instruction.
Related concepts
8.8 Conditional execution of NEON and VFP instructions on page 8-185.
Related references
5.6 Comparison of condition code meanings on page 5-111.
10.38 IT on page 10-366.
12.77 VMRS on page 12-678.
10.9 ADC
Add with Carry.
Syntax
ADC{S}{cond} {Rd}, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Usage
The ADC (Add with Carry) instruction adds the values in Rn and Operand2, together with the
carry flag.
You can use ADC to synthesize multiword arithmetic.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, the ADC instruction updates the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
ADCS Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
ADC{cond} Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.10 ADD
Add without Carry.
Syntax
ADD{S}{cond} {Rd}, Rn, Operand2
ADD{cond} {Rd}, Rn, #imm12 ; Thumb, 32-bit encoding only
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
imm12
is any value in the range 0-4095.
Operation
The ADD instruction adds the values in Rn and Operand2 or imm12.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
In ADD instructions without register-controlled shift, use of PC is deprecated except for the
following cases:
• Use of PC for Rd in instructions that do not add SP to a register.
• Use of PC for Rn and use of PC for Rm in instructions that add two registers other than SP.
• Use of PC for Rn in the instruction ADD{cond} Rd, Rn, #Constant.
If you use PC (R15) as Rn or Rm, the value used is the address of the instruction plus 8.
If you use PC as Rd:
• Execution branches to the address corresponding to the result.
• If you use the S suffix, see the SUBS pc,lr instruction.
You can use SP for Rn in ADD instructions, however, ADDS PC, SP, #Constant is deprecated.
You can use SP in ADD (register) if Rn is SP and shift is omitted or LSL #1, LSL #2, or LSL
#3.
Other uses of SP in these ARM instructions are deprecated.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, these instructions update the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of these instructions are available in Thumb code, and are 16-bit instructions:
ADDS Rd, Rn, #imm
imm range 0-7. Rd and Rn must both be Lo registers. This form can only be used outside
an IT block.
ADD{cond} Rd, Rn, #imm
imm range 0-7. Rd and Rn must both be Lo registers. This form can only be used inside an
IT block.
ADDS Rd, Rn, Rm
Rd, Rn and Rm must all be Lo registers. This form can only be used outside an IT block.
ADD{cond} Rd, Rn, Rm
Rd, Rn and Rm must all be Lo registers. This form can only be used inside an IT block.
ADD Rd, Rd, Rm
ARMv6 and earlier: either Rd or Rm, or both, must be a Hi register. ARMv6T2 and
above: this restriction does not apply.
ADDS Rd, Rd, #imm
imm range 0-255. Rd must be a Lo register. This form can only be used outside an IT
block.
ADD{cond} Rd, Rd, #imm
imm range 0-255. Rd must be a Lo register. This form can only be used inside an IT
block.
ADD SP, SP, #imm
imm range 0-508, word aligned.
ADD Rd, SP, #imm
imm range 0-1020, word aligned. Rd must be a Lo register.
ADD Rd, pc, #imm
imm range 0-1020, word aligned. Rd must be a Lo register. Bits[1:0] of the PC are read as
0 in this instruction.
Example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
10.140 SUBS pc, lr on page 10-522.
Related information
Handling Processor Exceptions.
Syntax
ADR{cond}{.W} Rd,label
where:
cond
is an optional condition code.
.W
is an optional instruction width specifier.
Rd
is the destination register to load.
label
is a PC-relative expression.
label must be within a limited distance of the current instruction.
Usage
ADR produces position-independent code, because the assembler generates an instruction that adds
or subtracts a value to the PC.
Use the ADRL pseudo-instruction to assemble a wider range of effective addresses.
label must evaluate to an address in the same assembler area as the ADR instruction.
If you use ADR to generate a target for a BX or BLX instruction, it is your responsibility to set the
Thumb bit (bit 0) of the address if the target contains Thumb instructions.
ADR in Thumb
You can use the .W width specifier to force ADR to generate a 32-bit instruction in Thumb code.
ADR with .W always generates a 32-bit instruction, even if the address can be generated in a 16-bit
instruction.
For forward references, ADR without .W always generates a 16-bit instruction in Thumb code,
even if that results in failure for an address that could be generated in a 32-bit Thumb ADD
instruction.
Restrictions
In Thumb code, Rd cannot be PC or SP.
In ARM code, Rd can be PC or SP but use of SP is deprecated in ARMv6T2 and above.
Related concepts
4.9 Load addresses to a register using ADR on page 4-77.
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.4 Syntax of Operand2 as a constant on page 10-311.
10.13 ADRL pseudo-instruction on page 10-327.
14.6 AREA on page 14-774.
10.8 Condition codes on page 10-317.
b Entries in the Architectures column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
c Rd must be in the range R0-R7.
d Must be a multiple of 4.
Syntax
ADR{cond}{.W} Rd,label
where:
cond
is an optional condition code.
.W
is an optional instruction width specifier.
Rd
is the destination register to load.
label
is a symbol defined by the FIELD directive. label specifies an offset from the base
register which is defined using the MAP directive.
label must be within a limited distance from the base register.
Usage
ADR generates code to easily access named fields inside a storage map.
Use the ADRL pseudo-instruction to assemble a wider range of effective addresses.
Restrictions
In Thumb code:
• Rd cannot be PC.
• Rd can be SP only if the base register is SP.
ADR in Thumb
You can use the .W width specifier to force ADR to generate a 32-bit instruction in Thumb code.
ADR with .W always generates a 32-bit instruction, even if the address can be generated in a 16-bit
instruction.
For forward references, ADR without .W, with base register SP, always generates a 16-bit
instruction in Thumb code, even if that results in failure for an address that could be generated in a
32-bit Thumb ADD instruction.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.4 Syntax of Operand2 as a constant on page 10-311.
10.13 ADRL pseudo-instruction on page 10-327.
14.51 MAP on page 14-828.
14.40 FIELD on page 14-813.
10.8 Condition codes on page 10-317.
e Entries in the Architectures column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
f Rd must be in the range R0-R7 or SP. If Rd is SP, the offset range is –508 to 508 and must be a multiple of 4
g Must be a multiple of 4.
Syntax
ADRL{cond} Rd,label
where:
cond
is an optional condition code.
Rd
is the register to load.
label
is a PC-relative or register-relative expression.
Usage
ADRL always assembles to two 32-bit instructions. Even if the address can be reached in a single
instruction, a second, redundant instruction is produced.
If the assembler cannot construct the address in two instructions, it generates an error message and
the assembly fails. You can use the LDR pseudo-instruction for loading a wider range of addresses.
ADRL is similar to the ADR instruction, except ADRL can load a wider range of addresses because it
generates two data processing instructions.
ADRL produces position-independent code, because the address is PC-relative or register-relative.
If label is PC-relative, it must evaluate to an address in the same assembler area as the ADRL
pseudo-instruction.
If you use ADRL to generate a target for a BX or BLX instruction, it is your responsibility to set the
Thumb bit (bit 0) of the address if the target contains Thumb instructions.
Note
When assembling Thumb instructions, ADRL is only available in ARMv6T2 and later.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
4.3 Load 32-bit immediates into registers on page 4-68.
Related references
10.4 Syntax of Operand2 as a constant on page 10-311.
10.45 LDR pseudo-instruction on page 10-385.
14.6 AREA on page 14-774.
10.10 ADD on page 10-320.
10.8 Condition codes on page 10-317.
Related information
ARM Architecture Reference Manual.
10.14 AND
Logical AND.
Syntax
AND{S}{cond} Rd, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The AND instruction performs bitwise AND operations on the values in Rn and Operand2.
In certain circumstances, the assembler can substitute BIC for AND, or AND for BIC. Be aware of
this when reading disassembly listings.
Condition flags
If S is specified, the AND instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
ANDS Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
Examples
AND r9,r2,#0xFF00
ANDS r9, r8, #0x19
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.15 ASR
Arithmetic Shift Right. This instruction is a preferred synonym for MOV instructions with shifted
register operands.
Syntax
ASR{S}{cond} Rd, Rm, Rs
ASR{S}{cond} Rd, Rm, #sh
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rm
is the register holding the first operand. This operand is shifted right.
Rs
is a register holding a shift value to apply to the value in Rm. Only the least significant
byte is used.
sh
is a constant shift. The range of values permitted is 1-32.
Operation
ASR provides the signed value of the contents of a register divided by a power of two. It copies the
sign bit into vacated bit positions on the left.
Note
The ARM instruction ASRS{cond} pc,Rm,#sh always disassembles to the preferred form
MOVS{cond} pc,Rm{,shift}.
Caution
Do not use the S suffix when using PC as Rd in User mode or System mode. The assembler cannot
warn you about this because it has no information about what the processor mode is likely to be at
execution time.
You cannot use PC for Rd or any operand in the ASR instruction if it has a register-controlled
shift.
Condition flags
If S is specified, the ASR instruction updates the N and Z flags according to the result.
The C flag is unaffected if the shift value is 0. Otherwise, the C flag is updated to the last bit
shifted out.
16-bit instructions
The following forms of these instructions are available in Thumb code, and are 16-bit instructions:
ASRS Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
ASR{cond} Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
ASRS Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used outside an IT block.
ASR{cond} Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used inside an IT block.
Architectures
The ASR ARM instruction is available in all architectures.
The ASR 32-bit Thumb instruction is available in ARMv6T2 and above.
The ASR 16-bit Thumb instruction is available in ARMv4T and above.
Example
Related references
10.56 MOV on page 10-402.
10.8 Condition codes on page 10-317.
10.16 B
Branch.
Syntax
B{cond}{.W} label
where:
cond
is an optional condition code.
.W
is an optional instruction width specifier to force the use of a 32-bit B instruction in
Thumb.
label
is a PC-relative expression.
Operation
The B instruction causes a branch to label.
B in Thumb
You can use the .W width specifier to force B to generate a 32-bit instruction in Thumb code.
B.W always generates a 32-bit instruction, even if the target could be reached using a 16-bit
instruction.
For forward references, B without .W always generates a 16-bit instruction in Thumb code, even if
that results in failure for a target that could be reached using a 32-bit Thumb instruction.
Condition flags
The B instruction does not change the flags.
Architectures
See the preceding table for details of availability of the B instruction in each architecture.
Example
B loopA
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
Related information
Information about image structure and generation.
10.17 BFC
Bit Field Clear.
Syntax
BFC{cond} Rd, #lsb, #width
where:
cond
is an optional condition code.
Rd
is the destination register.
lsb
is the least significant bit that is to be cleared.
width
is the number of bits to be cleared. width must not be 0, and (width+lsb) must be less
than 32.
Operation
Clears adjacent bits in a register. width bits in Rd are cleared, starting at lsb. Other bits in Rd are
unchanged.
Register restrictions
You cannot use PC for any register.
You can use SP in the BFC ARM instruction but this is deprecated in ARMv6T2 and above. You
cannot use SP in the BFC Thumb instruction.
Condition flags
The BFC instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.18 BFI
Bit Field Insert.
Syntax
BFI{cond} Rd, Rn, #lsb, #width
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the source register.
lsb
is the least significant bit that is to be copied.
width
is the number of bits to be copied. width must not be 0, and (width+lsb) must be less
than 32.
Operation
Inserts adjacent bits from one register into another. width bits in Rd, starting at lsb, are replaced
by width bits from Rn, starting at bit[0]. Other bits in Rd are unchanged.
Register restrictions
You cannot use PC for any register.
You can use SP in the BFI ARM instruction but this is deprecated in ARMv6T2 and above. You
cannot use SP in the BFI Thumb instruction.
Condition flags
The BFI instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.19 BIC
Bit Clear.
Syntax
BIC{S}{cond} Rd, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The BIC (Bit Clear) instruction performs an AND operation on the bits in Rn with the
complements of the corresponding bits in the value of Operand2.
In certain circumstances, the assembler can substitute BIC for AND, or AND for BIC. Be aware of
this when reading disassembly listings.
Condition flags
If S is specified, the BIC instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following forms of the BIC instruction are available in Thumb code, and are 16-bit
instructions:
Example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.20 BKPT
Breakpoint.
Syntax
BKPT #imm
where:
imm
is an expression evaluating to an integer in the range:
• 0-65535 (a 16-bit value) in an ARM instruction.
• 0-255 (an 8-bit value) in a 16-bit Thumb instruction.
Usage
The BKPT instruction causes the processor to enter Debug state. Debug tools can use this to
investigate system state when the instruction at a particular address is reached.
In both ARM state and Thumb state, imm is ignored by the ARM hardware. However, a debugger
can use it to store additional information about the breakpoint.
BKPT is an unconditional instruction. It must not have a condition code in ARM code. In Thumb
code, the BKPT instruction does not require a condition code suffix because BKPT always executes
irrespective of its condition code suffix.
Architectures
This ARM instruction is available in ARMv5T and above.
This 16-bit Thumb instruction is available in ARMv5T and above.
There is no 32-bit version of this instruction in Thumb.
10.21 BL
Branch with Link.
Syntax
BL{cond}{.W} label
where:
cond
is an optional condition code. cond is not available on all forms of this instruction.
.W
is an optional instruction width specifier to force the use of a 32-bit BL instruction in
Thumb.
label
is a PC-relative expression.
Operation
The BL instruction causes a branch to label, and copies the address of the next instruction into
LR (R14, the link register).
Condition flags
The BL instruction does not change the flags.
Architectures
See the preceding table for details of availability of the BL instruction in each architecture.
Examples
BLE ng+8
BL subC
BLLT rtX
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
Related information
Information about image structure and generation.
10.22 BLX
Branch with Link and exchange instruction set.
Syntax
BLX{cond}{.W} label
BLX{cond} Rm
where:
cond
is an optional condition code. cond is not available on all forms of this instruction.
.W
is an optional instruction width specifier to force the use of a 32-bit BLX instruction in
Thumb.
label
is a PC-relative expression.
Rm
is a register containing an address to branch to.
Operation
The BLX instruction causes a branch to label, or to the address contained in Rm. In addition:
• The BLX instruction copies the address of the next instruction into LR (R14, the link register).
• The BLX instruction can change the instruction set.
BLX label always changes the instruction set. It changes a processor in ARM state to Thumb
state, or a processor in Thumb state to ARM state.
BLX Rm derives the target instruction set from bit[0] of Rm:
— if bit[0] of Rm is 0, the processor changes to, or remains in, ARM state
— if bit[0] of Rm is 1, the processor changes to, or remains in, Thumb state.
BLX in ThumbEE
You can use the BLX instruction as a branch in ThumbEE code, but you cannot use it to change
state. You cannot use the BLX{cond} label form of this instruction in ThumbEE. In the register
form, bit[0] of Rm must be 1, and execution continues at the target address in ThumbEE state.
Register restrictions
You can use PC for Rm in the ARM BLX instruction, but this is deprecated in ARMv6T2 and
above. You cannot use PC in other ARM instructions.
You can use PC for Rm in the Thumb BLX instruction. You cannot use PC in other Thumb
instructions.
You can use SP for Rm in this ARM instruction but this is deprecated in ARMv6T2 and above.
You can use SP for Rm in the Thumb BLX instruction, but this is deprecated. You cannot use SP in
the other Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
See the preceding table for details of availability of the BLX instruction in each architecture.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
Related information
Information about image structure and generation.
10.23 BX
Branch and exchange instruction set.
Syntax
BX{cond} Rm
where:
cond
is an optional condition code. cond is not available on all forms of this instruction.
Rm
is a register containing an address to branch to.
Operation
The BX instruction causes a branch to the address contained in Rm and exchanges the instruction
set, if required:
• BX Rm derives the target instruction set from bit[0] of Rm:
— If bit[0] of Rm is 0, the processor changes to, or remains in, ARM state.
— If bit[0] of Rm is 1, the processor changes to, or remains in, Thumb state.
BX in ThumbEE
You can use the BX instruction as a branch in ThumbEE code, but you cannot use it to change
state. Bit[0] of Rm must be 1, and execution continues at the target address in ThumbEE state.
Register restrictions
You can use PC for Rm in the ARM BX instruction, but this is deprecated in ARMv6T2 and above.
You cannot use PC in other ARM instructions.
You can use PC for Rm in the Thumb BX instruction. You cannot use PC in other Thumb
instructions.
You can use SP for Rm in the ARM BX instruction but this is deprecated in ARMv6T2 and above.
You can use SP for Rm in the Thumb BX instruction, but this is deprecated.
Condition flags
The BX instruction does not change the flags.
k The assembler accepts BX{cond} Rm for code assembled for ARMv4 and converts it to MOV{cond} PC, Rm at
link time, unless objects targeted for ARMv4T are present.
Architectures
See the preceding table for details of availability of the BX instruction in each architecture.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
Related information
Information about image structure and generation.
10.24 BXJ
Branch and change to Jazelle state.
Syntax
BXJ{cond} Rm
where:
cond
is an optional condition code. cond is not available on all forms of this instruction.
Rm
is a register containing an address to branch to.
Operation
The BXJ instruction causes a branch to the address contained in Rm and changes the instruction set
state to Jazelle.
BXJ in ThumbEE
You can use this instruction as a branch in ThumbEE code, but you cannot use it to change state.
Bit[0] of Rm must be 1, and execution continues at the target address in ThumbEE state.
Note
BXJ behaves like BX in ThumbEE.
Register restrictions
You can use SP for Rm in the BXJ ARM instruction but this is deprecated in ARMv6T2 and above.
You cannot use SP in the BXJ Thumb instruction.
Condition flags
The BXJ instruction does not change the flags.
Architectures
See the preceding table for details of availability of the BXJ instruction in each architecture.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
Related information
Information about image structure and generation.
Syntax
CBZ Rn, label
CBNZ Rn, label
where:
Rn
is the register holding the operand.
label
is the branch destination.
Usage
You can use the CBZ or CBNZ instructions to avoid changing the condition flags and to reduce the
number of instructions.
Except that it does not change the condition flags, CBZ Rn, label is equivalent to:
CMP Rn, #0
BEQ label
Except that it does not change the condition flags, CBNZ Rn, label is equivalent to:
CMP Rn, #0
BNE label
Restrictions
The branch destination must be within 4 to 130 bytes after the instruction and in the same
execution state.
These instructions must not be used inside an IT block.
Condition flags
These instructions do not change the flags.
Architectures
These 16-bit Thumb instructions are available in ARMv6T2 and above.
There are no ARM or 32-bit Thumb encodings of these instructions.
Syntax
CDP{cond} coproc, #opcode1, CRd, CRn, CRm{, #opcode2}
CDP2{cond} coproc, #opcode1, CRd, CRn, CRm{, #opcode2}
where:
cond
is an optional condition code. In ARM code, cond is not permitted for CDP2.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
opcode1
is a 4-bit coprocessor-specific opcode.
opcode2
is an optional 3-bit coprocessor-specific opcode.
CRd, CRn, CRm
are coprocessor registers.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
Architectures
The CDP ARM instruction is available in all versions of the ARM architecture.
The CDP2 ARM instruction is available in ARMv5T and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no 16-bit versions of these instructions in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.27 CLREX
Clear Exclusive.
Syntax
CLREX{cond}
where:
cond
is an optional condition code.
Note
cond is permitted only in Thumb code, using a preceding IT instruction. This is an
unconditional instruction in ARM.
Usage
Use the CLREX instruction to clear the local record of the executing processor that an address has
had a request for an exclusive access.
CLREX returns a closely-coupled exclusive access monitor to its open-access state. This removes
the requirement for a dummy store to memory.
It is implementation defined whether CLREX also clears the global record of the executing
processor that an address has had a request for an exclusive access.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv7 and above.
There is no 16-bit CLREX instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
Related information
ARM Architecture Reference Manual.
10.28 CLZ
Count Leading Zeros.
Syntax
CLZ{cond} Rd, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the operand register.
Operation
The CLZ instruction counts the number of leading zeros in the value in Rm and returns the result in
Rd. The result value is 32 if no bits are set in the source register, and zero if bit 31 is set.
Register restrictions
You cannot use PC for any operand.
You can use SP in these ARM instructions but this is deprecated in ARMv6T2 and above.
You cannot use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv5T and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Examples
CLZ r4,r9
CLZNE r2,r3
Use the CLZ Thumb instruction followed by a left shift of Rm by the resulting Rd value to
normalize the value of register Rm. Use MOVS, rather than MOV, to flag the case where Rm is zero:
CLZ r5, r9
MOVS r9, r9, LSL r5
Related references
10.8 Condition codes on page 10-317.
Syntax
CMP{cond} Rn, Operand2
CMN{cond} Rn, Operand2
where:
cond
is an optional condition code.
Rn
is the ARM register holding the first operand.
Operand2
is a flexible second operand.
Operation
These instructions compare the value in a register with Operand2. They update the condition
flags on the result, but do not place the result in any register.
The CMP instruction subtracts the value of Operand2 from the value in Rn. This is the same as a
SUBS instruction, except that the result is discarded.
The CMN instruction adds the value of Operand2 to the value in Rn. This is the same as an ADDS
instruction, except that the result is discarded.
In certain circumstances, the assembler can substitute CMN for CMP, or CMP for CMN. Be aware of
this when reading disassembly listings.
Condition flags
These instructions update the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of these instructions are available in Thumb code, and are 16-bit instructions:
CMP Rn, Rm
Lo register restriction does not apply.
CMN Rn, Rm
Rn and Rm must both be Lo registers.
CMP Rn, #imm
Rn must be a Lo register. imm range 0-255.
Examples
CMP r2, r9
CMN r0, #6400
CMPGT sp, r7, LSL #2
Incorrect example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
10.30 CPS
Change Processor State.
Syntax
CPSeffect iflags{, #mode}
CPS #mode
where:
effect
is one of:
IE
Interrupt or abort enable.
ID
Interrupt or abort disable.
iflags
is a sequence of one or more of:
a
Enables or disables imprecise aborts.
i
Enables or disables IRQ interrupts.
f
Enables or disables FIQ interrupts.
mode
specifies the number of the mode to change to.
Usage
Changes one or more of the mode, A, I, and F bits in the CPSR, without changing the other CPSR
bits.
CPS is only permitted in privileged software execution, and has no effect in User mode.
CPS cannot be conditional, and is not permitted in an IT block.
Condition flags
This instruction does not change the condition flags.
16-bit instructions
The following forms of these instructions are available in Thumb code, and are 16-bit instructions:
• CPSIE iflags.
• CPSID iflags.
You cannot specify a mode change in a 16-bit Thumb instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction are available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in T variants of ARMv6 and above.
Examples
Syntax
CPY{cond} Rd, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to be copied.
Operation
The CPY pseudo-instruction copies a value from one register to another, without changing the
condition flags.
CPY Rd, Rm assembles to MOV Rd, Rm.
Architectures
This pseudo-instruction is available in ARMv6 and above in ARM code and in T variants of
ARMv6 and above in Thumb code.
Register restrictions
Using SP or PC for both Rd and Rm is deprecated.
Condition flags
This instruction does not change the condition flags.
Related references
10.56 MOV on page 10-402.
10.32 DBG
Debug.
Syntax
DBG{cond} {option}
where:
cond
is an optional condition code.
option
is an optional limitation on the operation of the hint. The range is 0-15.
Usage
DBG is a hint instruction. It is optional whether it is implemented or not. If it is not implemented, it
behaves as a NOP. The assembler produces a diagnostic message if the instruction executes as NOP
on the target.
DBG executes as a NOP instruction in ARMv6K and ARMv6T2.
Debug hint provides a hint to a debugger and related tools. See your debugger and related tools
documentation to determine the use, if any, of this instruction.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.69 NOP on page 10-420.
10.8 Condition codes on page 10-317.
10.33 DMB
Data Memory Barrier.
Syntax
DMB{cond} {option}
where:
cond
is an optional condition code.
Note
cond is permitted only in Thumb code. This is an unconditional instruction in ARM
code.
option
is an optional limitation on the operation of the hint. Permitted values are:
SY
Full system DMB operation. This is the default and can be omitted.
ST
DMB operation that waits only for stores to complete.
ISH
DMB operation only to the inner shareable domain.
ISHST
DMB operation that waits only for stores to complete, and only to the inner
shareable domain.
NSH
DMB operation only out to the point of unification.
NSHST
DMB operation that waits only for stores to complete and only out to the point of
unification.
OSH
DMB operation only to the outer shareable domain.
OSHST
DMB operation that waits only for stores to complete, and only to the outer
shareable domain.
Operation
Data Memory Barrier acts as a memory barrier. It ensures that all explicit memory accesses that
appear in program order before the DMB instruction are observed before any explicit memory
accesses that appear in program order after the DMB instruction. It does not affect the ordering of
any other instructions executing on the processor.
Alias
The following alternative values of option are supported, but ARM recommends that you do not
use them:
• SH is an alias for ISH.
• SHST is an alias for ISHST.
• UN is an alias for NSH.
• UNST is an alias for NSHST.
Architectures
This ARM and 32-bit Thumb instruction is available in ARMv7.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.34 DSB
Data Synchronization Barrier.
Syntax
DSB{cond} {option}
where:
cond
is an optional condition code.
Note
cond is permitted only in Thumb code. This is an unconditional instruction in ARM.
option
is an optional limitation on the operation of the hint. Permitted values are:
SY
Full system DSB operation. This is the default and can be omitted.
ST
DSB operation that waits only for stores to complete.
ISH
DSB operation only to the inner shareable domain.
ISHST
DSB operation that waits only for stores to complete, and only to the inner
shareable domain.
NSH
DSB operation only out to the point of unification.
NSHST
DSB operation that waits only for stores to complete and only out to the point of
unification.
OSH
DSB operation only to the outer shareable domain.
OSHST
DSB operation that waits only for stores to complete, and only to the outer
shareable domain.
Operation
Data Synchronization Barrier acts as a special kind of memory barrier. No instruction in program
order after this instruction executes until this instruction completes. This instruction completes
when:
• All explicit memory accesses before this instruction complete.
• All Cache, Branch predictor and TLB maintenance operations before this instruction complete.
Alias
The following alternative values of option are supported for DSB, but ARM recommends that
you do not use them:
• SH is an alias for ISH.
• SHST is an alias for ISHST.
• UN is an alias for NSH.
• UNST is an alias for NSHST.
Architectures
This ARM and 32-bit Thumb instruction is available in ARMv7.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.35 EOR
Logical Exclusive OR.
Syntax
EOR{S}{cond} Rd, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The EOR instruction performs bitwise Exclusive OR operations on the values in Rn and
Operand2.
Condition flags
If S is specified, the EOR instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following forms of the EOR instruction are available in Thumb code, and are 16-bit
instructions:
EORS Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
EOR{cond} Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
It does not matter if you specify EOR{S} Rd, Rm, Rd. The instruction is the same.
Examples
EORS r0,r0,r3,ROR r6
EORS r7, r11, #0x18181818
Incorrect example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.36 ERET
Exception Return.
Syntax
ERET{cond}
where:
cond
is an optional condition code.
Usage
In a processor that implements the Virtualization Extensions, you can use ERET to perform a
return from an exception taken to Hyp mode.
Operation
When executed in Hyp mode, ERET loads the PC from ELR_hyp and loads the CPSR from
SPSR_hyp. When executed in any other mode, apart from User or System, it behaves as:
• MOVS PC, LR in the ARM instruction set.
• SUBS PC, LR, #0 in the Thumb instruction set.
Notes
You must not use ERET in ThumbEE state or in User or System mode. The assembler cannot
detect the use of ERET in User or System mode, but it can detect and diagnose it in ThumbEE
state.
ERET is the preferred synonym for SUBS PC, LR, #0 in the Thumb instruction set.
Architectures
This ARM instruction is available in ARMv7 architectures that include the Virtualization
Extensions.
This 32-bit Thumb instruction is available in ARMv7 architectures that include the Virtualization
Extensions.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.4 Processor modes, and privileged and unprivileged software execution on page 2-38.
Related references
10.56 MOV on page 10-402.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
10.37 ISB
Instruction Synchronization Barrier.
Syntax
ISB{cond} {option}
where:
cond
is an optional condition code.
Note
cond is permitted only in Thumb code. This is an unconditional instruction in ARM.
option
is an optional limitation on the operation of the hint. The permitted value is:
SY
Full system ISB operation. This is the default, and can be omitted.
Operation
Instruction Synchronization Barrier flushes the pipeline in the processor, so that all instructions
following the ISB are fetched from cache or memory, after the instruction has been completed. It
ensures that the effects of context altering operations, such as changing the ASID, or completed
TLB maintenance operations, or branch predictor maintenance operations, in addition to all
changes to the CP15 registers, executed before the ISB instruction are visible to the instructions
fetched after the ISB.
In addition, the ISB instruction ensures that any branches that appear in program order after it are
always written into the branch prediction logic with the context that is visible after the ISB
instruction. This is required to ensure correct execution of the instruction stream.
Note
When the target architecture is ARMv7-M, you cannot use an ISB instruction in an IT block,
unless it is the last instruction in the block.
Architectures
This ARM and 32-bit Thumb instruction is available in ARMv7.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.38 IT
If-Then.
Syntax
IT{x{y{z}}} {cond}
where:
x
specifies the condition switch for the second instruction in the IT block.
y
specifies the condition switch for the third instruction in the IT block.
z
specifies the condition switch for the fourth instruction in the IT block.
cond
specifies the condition for the first instruction in the IT block.
The condition switch for the second, third and fourth instruction in the IT block can be either:
T
Then. Applies the condition cond to the instruction.
E
Else. Applies the inverse condition of cond to the instruction.
Usage
The IT instruction makes up to four following instructions (the IT block) conditional. The
conditions can be all the same, or some of them can be the logical inverse of the others.
The instructions (including branches) in the IT block, except the BKPT instruction, must specify
the condition in the {cond} part of their syntax.
You are not required to write IT instructions in your code, because the assembler generates them
for you automatically according to the conditions specified on the following instructions.
However, if you do write IT instructions, the assembler validates the conditions specified in the
IT instructions against the conditions specified in the following instructions.
Writing the IT instructions ensures that you consider the placing of conditional instructions, and
the choice of conditions, in the design of your code.
When assembling to ARM code, the assembler performs the same checks, but does not generate
any IT instructions.
With the exception of CMP, CMN, and TST, the 16-bit instructions that normally affect the
condition flags, do not affect them when used inside an IT block.
A BKPT instruction in an IT block is always executed, so it does not require a condition in the
{cond} part of its syntax. The IT block continues from the next instruction.
Note
You can use an IT block for unconditional instructions by using the AL condition.
Conditional branches inside an IT block have a longer branch range than those outside the IT
block.
Restrictions
The following instructions are not permitted in an IT block:
• IT.
• CBZ and CBNZ.
• TBB and TBH.
• CPS, CPSID and CPSIE.
• SETEND.
Other restrictions when using an IT block are:
• A branch or any instruction that modifies the PC is only permitted in an IT block if it is the last
instruction in the block.
• You cannot branch to any instruction in an IT block, unless when returning from an exception
handler.
• You cannot use any assembler directives in an IT block.
Note
The assembler shows a diagnostic message when any of these instructions are used in an IT block.
Condition flags
This instruction does not change the flags.
Exceptions
Exceptions can occur between an IT instruction and the corresponding IT block, or within an IT
block. This exception results in entry to the appropriate exception handler, with suitable return
information in LR and SPSR.
Instructions designed for use as exception returns can be used as normal to return from the
exception, and execution of the IT block resumes correctly. This is the only way that a PC-
modifying instruction can branch to an instruction in an IT block.
Architectures
This 16-bit Thumb instruction is available in ARMv6T2 and above.
In ARM code, IT is a pseudo-instruction that does not generate any code.
There is no 32-bit version of this instruction.
Examples
Incorrect example
IT NE
ADD r0,r0,r1 ; syntax error: no condition code used in IT block
Syntax
op{L}{cond} coproc, CRd, [Rn]
op{L}{cond} coproc, CRd, [Rn, #{-}offset] ; offset addressing
op{L}{cond} coproc, CRd, [Rn, #{-}offset]! ; pre-index addressing
op{L}{cond} coproc, CRd, [Rn], #{-}offset ; post-index addressing
op{L}{cond} coproc, CRd, label
where:
op
is LDC or LDC2.
cond
is an optional condition code.
In ARM code, cond is not permitted for LDC2.
L
is an optional suffix specifying a long transfer.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
CRd
is the coprocessor register to load.
Rn
is the register on which the memory address is based. If PC is specified, the value used is
the address of the current instruction plus eight.
-
is an optional minus sign. If - is present, the offset is subtracted from Rn. Otherwise, the
offset is added to Rn.
offset
is an expression evaluating to a multiple of 4, in the range 0 to 1020.
!
is an optional suffix. If ! is present, the address including the offset is written back into
Rn.
label
is a word-aligned PC-relative expression.
label must be within 1020 bytes of the current instruction.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
In ThumbEE, if the value in the base register is zero, execution branches to the NullCheck handler
at HandlerBase - 4.
Architectures
LDC is available in all versions of the ARM architecture.
LDC2 is available in ARMv5T and above.
Register restrictions
You cannot use PC for Rn in the pre-index and post-index instructions. These are the forms that
write back to Rn.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
10.40 LDM
Load Multiple registers.
Syntax
LDM{addr_mode}{cond} Rn{!}, reglist{^}
where:
addr_mode
is any one of the following:
IA
Increment address After each transfer. This is the default, and can be omitted.
IB
Increment address Before each transfer (ARM only).
DA
Decrement address After each transfer (ARM only).
DB
Decrement address Before each transfer.
You can also use the stack oriented addressing mode suffixes, for example, when
implementing stacks.
cond
is an optional condition code.
Rn
is the base register, the ARM register holding the initial address for the transfer. Rn must
not be PC.
!
is an optional suffix. If ! is present, the final address is written back into Rn.
reglist
is a list of one or more registers to be loaded, enclosed in braces. It can contain register
ranges. It must be comma separated if it contains more than one register or register range.
Any combination of registers R0 to R15 (PC) can be transferred in ARM state, but there
are some restrictions in Thumb state.
^
is an optional suffix, available in ARM state only. You must not use it in User mode or
System mode. It has the following purposes:
• If reglist contains the PC (R15), in addition to the normal multiple register
transfer, the SPSR is copied into the CPSR. This is for returning from exception
handlers. Use this only from exception modes.
• Otherwise, data is transferred into or out of the User mode registers instead of the
current mode registers.
You can use the --diag_warning 1645 assembler command line option to check when an
instruction substitution occurs.
16-bit instructions
16-bit versions of a subset of these instructions are available in Thumb code.
The following restrictions apply to the 16-bit instructions:
• All registers in reglist must be Lo registers.
• Rn must be a Lo register.
• addr_mode must be omitted (or IA), meaning increment address after each transfer.
• Writeback must be specified for LDM instructions where Rn is not in the reglist.
In addition, the PUSH and POP instructions are subsets of the STM and LDM instructions and can
therefore be expressed using the STM and LDM instructions. Some forms of PUSH and POP are also
16-bit instructions.
Note
These 16-bit instructions are not available in ThumbEE.
Loading to the PC
A load to the PC causes a branch to the instruction at the address loaded.
In ARMv4, bits[1:0] of the address loaded must be 0b00.
In ARMv5T and above:
• Bits[1:0] must not be 0b10.
• If bit[0] is 1, execution continues in Thumb state.
• If bit[0] is 0, execution continues in ARM state.
Example
Incorrect example
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.74 POP on page 10-429.
10.8 Condition codes on page 10-317.
Syntax
LDR{type}{cond} Rt, [Rn {, #offset}] ; immediate offset
LDR{type}{cond} Rt, [Rn, #offset]! ; pre-indexed
LDR{type}{cond} Rt, [Rn], #offset ; post-indexed
LDRD{cond} Rt, Rt2, [Rn {, #offset}] ; immediate offset, doubleword
LDRD{cond} Rt, Rt2, [Rn, #offset]! ; pre-indexed, doubleword
LDRD{cond} Rt, Rt2, [Rn], #offset ; post-indexed, doubleword
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to load.
Rn
is the register on which the memory address is based.
offset
is an offset. If offset is omitted, the address is the contents of Rn.
Rt2
is the additional register to load for doubleword operations.
Not all options are available in every instruction set and architecture.
Table 10-10 Offsets and architectures, LDR, word, halfword, and byte
Table 10-10 Offsets and architectures, LDR, word, halfword, and byte (continued)
Register restrictions
Rn must be different from Rt in the pre-index and post-index forms.
Use of PC
In ARM code you can use PC for Rt in LDR word instructions and PC for Rn in LDR instructions.
Other uses of PC are not permitted in these ARM instructions.
l Entries in the Architecture column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
EE
ThumbEE variants of the ARM architecture.
m For word loads, Rt can be the PC. A load to the PC causes a branch to the address loaded. In ARMv4, bits[1:0] of
the address loaded must be 0b00. In ARMv5T and above, bits[1:0] must not be 0b10, and if bit[0] is 1, execution
continues in Thumb state, otherwise execution continues in ARM state.
n Rt and Rn must be in the range R0-R7.
o Must be divisible by 4.
p Must be divisible by 2.
q Rt must be in the range R0-R7.
In Thumb code you can use PC for Rt in LDR word instructions and PC for Rn in LDR instructions.
Other uses of PC in these Thumb instructions are not permitted.
Use of SP
You can use SP for Rn.
In ARM code, you can use SP for Rt in word instructions. You can use SP for Rt in non-word
instructions in ARM code but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in word instructions only. All other use of SP for Rt in
these instructions are not permitted in Thumb code.
Examples
Related references
10.8 Condition codes on page 10-317.
Syntax
LDR{type}{cond}{.W} Rt, label
LDRD{cond} Rt, Rt2, label ; Doubleword
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
.W
is an optional instruction width specifier.
Rt
is the register to load or store.
Rt2
is the second register to load or store.
label
is a PC-relative expression.
label must be within a limited distance of the current instruction.
Note
Equivalent syntaxes are available for the STR instruction in ARM code but they are deprecated in
ARMv6T2 and above.
Note
In ARMv7-M, LDRD (PC-relative) instructions must be on a word-aligned address.
Use of SP
In ARM code, you can use SP for Rt in LDR word instructions. You can use SP for Rt in LDR
non-word ARM instructions but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in LDR word instructions only. All other uses of SP in these
instructions are not permitted in Thumb code.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
r Entries in the Architectures column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
s For word loads, Rt can be the PC. A load to the PC causes a branch to the address loaded. In ARMv4, bits[1:0] of
the address loaded must be 0b00. In ARMv5T and above, bits[1:0] must not be 0b10, and if bit[0] is 1, execution
continues in Thumb state, otherwise execution continues in ARM state.
t Must be a multiple of 4.
u Rt must be in the range R0-R7. There are no byte, halfword, or doubleword 16-bit instructions.
Related references
10.8 Condition codes on page 10-317.
Syntax
LDR{type}{cond} Rt, [Rn, ±Rm {, shift}] ; register offset
LDR{type}{cond} Rt, [Rn, ±Rm {, shift}]! ; pre-indexed ; ARM only
LDR{type}{cond} Rt, [Rn], ±Rm {, shift} ; post-indexed ; ARM only
LDRD{cond} Rt, Rt2, [Rn, ±Rm] ; register offset, doubleword ; ARM only
LDRD{cond} Rt, Rt2, [Rn, ±Rm]! ; pre-indexed, doubleword ; ARM only
LDRD{cond} Rt, Rt2, [Rn], ±Rm ; post-indexed, doubleword ; ARM only
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to load.
Rn
is the register on which the memory address is based.
Rm
is a register containing a value to be used as the offset. –Rm is not permitted in Thumb
code.
shift
is an optional shift.
Rt2
is the additional register to load for doubleword operations.
Not all options are available in every instruction set and architecture.
Register restrictions
In the pre-index and post-index forms:
• Rn must be different from Rt.
• Rn must be different from Rm in architectures before ARMv6.
v Where +/–Rm is shown, you can use –Rm, +Rm, or Rm. Where +Rm is shown, you cannot use –Rm.
w Entries in the Architecture column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
EE
ThumbEE variants of the ARM architecture.
x For word loads, Rt can be the PC. A load to the PC causes a branch to the address loaded. In ARMv4, bits[1:0] of
the address loaded must be 0b00. In ARMv5T and above, bits[1:0] must not be 0b10, and if bit[0] is 1, execution
continues in Thumb state, otherwise execution continues in ARM state.
y Rt, Rn, and Rm must all be in the range R0-R7.
Use of PC
In ARM instructions you can use PC for Rt in LDR word instructions, and you can use PC for Rn
in LDR instructions with register offset syntax (that is the forms that do not writeback to the Rn).:
Other uses of PC are not permitted in ARM instructions.
In Thumb instructions you can use PC for Rt in LDR word instructions. Other uses of PC in these
Thumb instructions are not permitted.
Use of SP
You can use SP for Rn.
In ARM code, you can use SP for Rt in word instructions. You can use SP for Rt in non-word
ARM instructions but this is deprecated in ARMv6T2 and above.
You can use SP for Rm in ARM instructions but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in word instructions only. All other use of SP for Rt in
these instructions are not permitted in Thumb code.
Use of SP for Rm is not permitted in Thumb state.
Related references
10.8 Condition codes on page 10-317.
Syntax
LDR{type}{cond}{.W} Rt, label
LDRD{cond} Rt, Rt2, label ; Doubleword
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
.W
is an optional instruction width specifier.
Rt
is the register to load or store.
Rt2
is the second register to load or store.
label
is a symbol defined by the FIELD directive. label specifies an offset from the base
register which is defined using the MAP directive.
label must be within a limited distance of the value in the base register.
Use of PC
You can use PC for Rt in word instructions. Other uses of PC are not permitted in these
instructions.
z Entries in the Architectures column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
EE
ThumbEE variants of the ARM architecture.
aa For word loads, Rt can be the PC. A load to the PC causes a branch to the address loaded. In ARMv4, bits[1:0] of
the address loaded must be 0b00. In ARMv5T and above, bits[1:0] must not be 0b10, and if bit[0] is 1, execution
continues in Thumb state, otherwise execution continues in ARM state.
ab Must be a multiple of 4.
ac Rt and base register must be in the range R0-R7.
ad Must be a multiple of 2.
ae Rt must be in the range R0-R7.
Use of SP
In ARM code, you can use SP for Rt in word instructions. You can use SP for Rt in non-word
ARM instructions but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in word instructions only. All other use of SP for Rt in
these instructions are not permitted in Thumb code.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
14.40 FIELD on page 14-813.
14.51 MAP on page 14-828.
10.8 Condition codes on page 10-317.
Note
This describes the LDR pseudo-instruction only, and not the LDR instruction.
Syntax
LDR{cond}{.W} Rt, =expr
LDR{cond}{.W} Rt, =label_expr
where:
cond
is an optional condition code.
.W
is an optional instruction width specifier.
Rt
is the register to be loaded.
expr
evaluates to a numeric value.
label_expr
is a PC-relative or external expression of an address in the form of a label plus or minus a
numeric value.
Usage
When using the LDR pseudo-instruction:
• If the value of expr can be loaded with a valid MOV or MVN instruction, the assembler uses that
instruction.
• If a valid MOV or MVN instruction cannot be used, or if the label_expr syntax is used, the
assembler places the constant in a literal pool and generates a PC-relative LDR instruction that
reads the constant from the literal pool.
Note
— An address loaded in this way is fixed at link time, so the code is not position-independent.
— The address holding the constant remains valid regardless of where the linker places the
ELF section containing the LDR instruction.
The assembler places the value of label_expr in a literal pool and generates a PC-relative LDR
instruction that loads the value from the literal pool.
If label_expr is an external expression, or is not contained in the current section, the assembler
places a linker relocation directive in the object file. The linker generates the address at link time.
If label_expr is either a named or numeric local label, the assembler places a linker relocation
directive in the object file and generates a symbol for that local label. The address is generated at
link time. If the local label references Thumb code, the Thumb bit (bit 0) of the address is set.
The offset from the PC to the value in the literal pool must be less than ±4KB (in an ARM or 32-
bit Thumb encoding) or in the range 0 to +1KB (16-bit Thumb encoding). You are responsible for
ensuring that there is a literal pool within range.
If the label referenced is in Thumb code, the LDR pseudo-instruction sets the Thumb bit (bit 0) of
label_expr.
Note
In RealView Compilation Tools (RVCT) v2.2, the Thumb bit of the address was not set. If you
have code that relies on this behavior, use the command line option --untyped_local_labels
to force the assembler not to set the Thumb bit when referencing labels in Thumb code.
Examples
Related concepts
7.3 Numeric constants on page 7-147.
7.5 Register-relative and PC-relative expressions on page 7-149.
7.10 Numeric local labels on page 7-154.
4.3 Load 32-bit immediates into registers on page 4-68.
4.6 Load 32-bit immediate values to a register using LDR Rd, =const on page 4-73.
Related references
9.70 --untyped_local_labels on page 9-290.
10.57 MOV32 pseudo-instruction on page 10-404.
10.8 Condition codes on page 10-317.
14.49 LTORG on page 14-824.
Syntax
LDR{type}T{cond} Rt, [Rn {, #offset}] ; immediate offset (32-bit Thumb
encoding only)
LDR{type}T{cond} Rt, [Rn] {, #offset} ; post-indexed (ARM only)
LDR{type}T{cond} Rt, [Rn], ±Rm {, shift} ; post-indexed (register) (ARM
only)
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to load.
Rn
is the register on which the memory address is based.
offset
is an offset. If offset is omitted, the address is the value in Rn.
Rm
is a register containing a value to be used as the offset. Rm must not be PC.
shift
is an optional shift.
Operation
When these instructions are executed by privileged software, they access memory with the same
restrictions as they would have if they were executed by unprivileged software.
When executed by unprivileged software these instructions behave in exactly the same way as the
corresponding load instruction, for example LDRSBT behaves in the same way as LDRSB.
Related references
10.8 Condition codes on page 10-317.
10.47 LDREX
Load Register Exclusive.
Syntax
LDREX{cond} Rt, [Rn {, #offset}]
LDREXB{cond} Rt, [Rn]
LDREXH{cond} Rt, [Rn]
LDREXD{cond} Rt, Rt2, [Rn]
where:
cond
is an optional condition code.
Rd
is the destination register for the returned status.
Rt
is the register to load.
Rt2
is the second register for doubleword loads.
Rn
is the register on which the memory address is based.
offset
is an optional offset applied to the value in Rn. offset is permitted only in 32-bit Thumb
instructions. If offset is omitted, an offset of zero is assumed.
Operation
LDREX loads data from memory.
• If the physical address has the Shared TLB attribute, LDREX tags the physical address as
exclusive access for the current processor, and clears any exclusive access tag for this
processor for any other physical address.
• Otherwise, it tags the fact that the executing processor has an outstanding tagged physical
address.
Restrictions
PC must not be used for any of Rd, Rt, Rt2, or Rn.
For ARM instructions:
• SP can be used but use of SP for any of Rd, Rt, or Rt2 is deprecated in ARMv6T2 and above.
• For LDREXD, Rt must be an even numbered register, and not LR.
• Rt2 must be R(t+1).
• offset is not permitted.
For Thumb instructions:
• SP can be used for Rn, but must not be used for any of Rd, Rt, or Rt2.
• For LDREXD, Rt and Rt2 must not be the same register.
• The value of offset can be any multiple of four in the range 0-1020.
Usage
Use LDREX and STREX to implement interprocess communication in multiple-processor and
shared-memory systems.
For reasons of performance, keep the number of instructions between corresponding LDREX and
STREX instructions to a minimum.
Note
The address used in a STREX instruction must be the same as the address in the most recently
executed LDREX instruction.
Architectures
ARM LDREX and STREX are available in ARMv6 and above.
ARM LDREXB, LDREXH, LDREXD, STREXB, STREXD, and STREXH are available in ARMv6K and
above.
All these 32-bit Thumb instructions are available in ARMv6T2 and above, except that LDREXD
and STREXD are not available in the ARMv7-M architecture.
There are no 16-bit versions of these instructions.
Examples
Related references
10.8 Condition codes on page 10-317.
10.48 LSL
Logical Shift Left. This instruction is a preferred synonym for MOV instructions with shifted
register operands.
Syntax
LSL{S}{cond} Rd, Rm, Rs
LSL{S}{cond} Rd, Rm, #sh
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rm
is the register holding the first operand. This operand is shifted right.
Rs
is a register holding a shift value to apply to the value in Rm. Only the least significant
byte is used.
sh
is a constant shift. The range of values permitted is 0-31.
Operation
LSL provides the value of a register multiplied by a power of two, inserting zeros into the vacated
bit positions.
Note
The ARM instruction LSLS{cond} pc,Rm,#sh always disassembles to the preferred form
MOVS{cond} pc,Rm{,shift}.
Caution
Do not use the S suffix when using PC as Rd in User mode or System mode. The assembler cannot
warn you about this because it has no information about what the processor mode is likely to be at
execution time.
You cannot use PC for Rd or any operand in the LSL instruction if it has a register-controlled shift.
Condition flags
If S is specified, the LSL instruction updates the N and Z flags according to the result.
The C flag is unaffected if the shift value is 0. Otherwise, the C flag is updated to the last bit
shifted out.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
LSLS Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
LSL{cond} Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
LSLS Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used outside an IT block.
LSL{cond} Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used inside an IT block.
Architectures
This ARM instruction is available in all architectures.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv4T and above.
Example
Related references
10.56 MOV on page 10-402.
10.8 Condition codes on page 10-317.
10.49 LSR
Logical Shift Right. This instruction is a preferred synonym for MOV instructions with shifted
register operands.
Syntax
LSR{S}{cond} Rd, Rm, Rs
LSR{S}{cond} Rd, Rm, #sh
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rm
is the register holding the first operand. This operand is shifted right.
Rs
is a register holding a shift value to apply to the value in Rm. Only the least significant
byte is used.
sh
is a constant shift. The range of values permitted is 1-32.
Operation
LSR provides the unsigned value of a register divided by a variable power of two, inserting zeros
into the vacated bit positions.
Note
The ARM instruction LSRS{cond} pc,Rm,#sh always disassembles to the preferred form
MOVS{cond} pc,Rm{,shift}.
Caution
Do not use the S suffix when using PC as Rd in User mode or System mode. The assembler cannot
warn you about this because it has no information about what the processor mode is likely to be at
execution time.
You cannot use PC for Rd or any operand in the LSR instruction if it has a register-controlled shift.
Condition flags
If S is specified, the instruction updates the N and Z flags according to the result.
The C flag is unaffected if the shift value is 0. Otherwise, the C flag is updated to the last bit
shifted out.
16-bit instructions
The following forms of these instructions are available in Thumb code, and are 16-bit instructions:
LSRS Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
LSR{cond} Rd, Rm, #sh
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
LSRS Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used outside an IT block.
LSR{cond} Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used inside an IT block.
Architectures
This ARM instruction is available in all architectures.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv4T and above.
Example
Related references
10.56 MOV on page 10-402.
10.8 Condition codes on page 10-317.
10.50 MAR
Transfer between two general-purpose registers and a 40-bit internal accumulator.
Syntax
MAR{cond} Acc, RdLo, RdHi
where:
cond
is an optional condition code.
Acc
is the internal accumulator. The standard name is accx,where x is an integer in the range
0 to n. The value of n depends on the processor. It is 0 for current processors.
RdLo, RdHi
are general-purpose registers. RdLo and RdHi must not be the PC.
Operation
The MAR instruction copies the contents of RdLo to bits[31:0] of Acc, and the least significant byte
of RdHi to bits[39:32] of Acc.
Architectures
The MAR ARM coprocessor 0 instruction is only available in XScale processors.
There is no Thumb version of the MAR instruction.
Examples
Related references
10.8 Condition codes on page 10-317.
Syntax
MCR{cond} coproc, #opcode1, Rt, CRn, CRm{, #opcode2}
MCR2{cond} coproc, #opcode1, Rt, CRn, CRm{, #opcode2}
where:
cond
is an optional condition code. In ARM code, cond is not permitted for MCR2.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
opcode1
is a 3-bit coprocessor-specific opcode.
opcode2
is an optional 3-bit coprocessor-specific opcode.
Rt
is an ARM source register. Rt must not be PC.
CRn, CRm
are coprocessor registers.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
Architectures
The MCR ARM instruction is available in all versions of the ARM architecture.
The MCR2 ARM instruction is available in ARMv5T and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no 16-bit versions of these instructions in Thumb.
Related references
10.8 Condition codes on page 10-317.
Syntax
MCRR{cond} coproc, #opcode, Rt, Rt2, CRn
MCRR2{cond} coproc, #opcode, Rt, Rt2, CRn
where:
cond
is an optional condition code. In ARM code, cond is not permitted for MCRR2.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
opcode
is a 4-bit coprocessor-specific opcode.
Rt, Rt2
are ARM source registers. Rt and Rt2 must not be PC.
CRn
is a coprocessor register.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
Architectures
The MCRR ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
The MCRR2 ARM instruction is available in ARMv6 and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no 16-bit versions of these instructions in Thumb.
Related references
10.8 Condition codes on page 10-317.
Syntax
MIA{cond} Acc, Rn, Rm
MIAPH{cond} Acc, Rn, Rm
MIA<x><y>{cond} Acc, Rn, Rm
where:
cond
is an optional condition code.
Acc
is the internal accumulator. The standard name is accx, where x is an integer in the range
0 to n. The value of n depends on the processor. It is 0 in current processors.
Rn, Rm
are the ARM registers holding the values to be multiplied.
Rn and Rm must not be PC.
<x><y>
is one of: BB, BT, TB, TT.
Operation
These instructions multiply either 16-bit or 32-bit signed integers, adding the result to a 40-bit
accumulator.
The MIA instruction multiplies the signed integers from Rn and Rm, and adds the result to the 40-
bit value in Acc.
The MIAPH instruction multiplies the signed integers from the bottom halves of Rn and Rm,
multiplies the signed integers from the upper halves of Rn and Rm, and adds the two 32-bit results
to the 40-bit value in Acc.
The MIAxy instruction multiplies the signed integer from the selected half of Rs by the signed
integer from the selected half of Rm, and adds the 32-bit result to the 40-bit value in Acc. <x> ==
B means use the bottom half (bits [15:0]) of Rn, <x> == T means use the top half (bits [31:16]) of
Rn. <y> == B means use the bottom half (bits [15:0]) of Rm, <y> == T means use the top half (bits
[31:16]) of Rm.
Condition flags
These instructions do not change the flags.
Note
These instructions cannot raise an exception. If overflow occurs on these instructions, the result
wraps round without any warning.
Architectures
These ARM coprocessor 0 instructions are only available in XScale processors.
There are no Thumb versions of these instructions.
Examples
MIA acc0,r5,r0
MIALE acc0,r1,r9
MIAPH acc0,r0,r7
MIAPHNE acc0,r11,r10
MIABB acc0,r8,r9
MIABT acc0,r8,r8
MIATB acc0,r5,r3
MIATT acc0,r0,r6
MIABTGT acc0,r2,r5
Related references
10.8 Condition codes on page 10-317.
10.54 MLA
Multiply-Accumulate with signed or unsigned 32-bit operands, giving the least significant 32 bits
of the result.
Syntax
MLA{S}{cond} Rd, Rn, Rm, Ra
where:
cond
is an optional condition code.
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rn, Rm
are registers holding the values to be multiplied.
Ra
is a register holding the value to be added.
Operation
The MLA instruction multiplies the values from Rn and Rm, adds the value from Ra, and places the
least significant 32 bits of the result in Rd.
Register restrictions
Rn must be different from Rd in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, the MLA instruction:
• Updates the N and Z flags according to the result.
• Corrupts the C and V flag in ARMv4.
• Does not affect the C or V flag in ARMv5T and above.
Architectures
The MLA ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
Example
Related references
10.8 Condition codes on page 10-317.
10.55 MLS
Multiply-Subtract, with signed or unsigned 32-bit operands, giving the least significant 32 bits of
the result.
Syntax
MLS{cond} Rd, Rn, Rm, Ra
where:
cond
is an optional condition code.
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rn, Rm
are registers holding the values to be multiplied.
Ra
is a register holding the value to be subtracted from.
Operation
The MLS instruction multiplies the values in Rn and Rm, subtracts the result from the value in Ra,
and places the least significant 32 bits of the final result in Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Architectures
The MLS ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
Example
Related references
10.8 Condition codes on page 10-317.
10.56 MOV
Move.
Syntax
MOV{S}{cond} Rd, Operand2
MOV{cond} Rd, #imm16
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Operand2
is a flexible second operand.
imm16
is any value in the range 0-65535.
Operation
The MOV instruction copies the value of Operand2 into Rd.
In certain circumstances, the assembler can substitute MVN for MOV, or MOV for MVN. Be aware of
this when reading disassembly listings.
Note
• You cannot use PC for Rd in MOV Rd, #imm16 if the #imm16 value is not a permitted
Operand2 value. You can use PC in forms with Operand2 without register-controlled shift.
• The deprecation of PC and SP in ARM instructions only applies to ARMv6T2 and above.
If you use PC as Rm, the value used is the address of the instruction plus 8.
If you use PC as Rd:
• Execution branches to the address corresponding to the result.
• If you use the S suffix, see the SUBS pc,lr instruction.
Condition flags
If S is specified, the instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
MOVS Rd, #imm
Rd must be a Lo register. imm range 0-255. This form can only be used outside an IT
block.
MOV{cond} Rd, #imm
Rd must be a Lo register. imm range 0-255. This form can only be used inside an IT
block.
MOVS Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
MOV{cond} Rd, Rm
In architectures before ARMv6, either Rd or Rm, or both, must be a Hi register. In
ARMv6 and above, this restriction does not apply.
Architectures
The #imm16 form of the ARM instruction is available in ARMv6T2 and above. The other forms
of the ARM instruction are available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in all T variants of the ARM architecture.
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
Syntax
MOV32{cond} Rd, expr
where:
cond
is an optional condition code.
Rd
is the register to be loaded. Rd must not be SP or PC.
expr
can be any one of the following:
symbol
A label in this or another program area.
#constant
Any 32-bit immediate value.
symbol + constant
A label plus a 32-bit immediate value.
Usage
MOV32 always generates two 32-bit instructions, a MOV, MOVT pair. This enables you to load any
32-bit immediate, or to access the whole 32-bit address space.
The main purposes of the MOV32 pseudo-instruction are:
• To generate literal constants when an immediate value cannot be generated in a single
instruction.
• To load a PC-relative or external address into a register. The address remains valid regardless
of where the linker places the ELF section containing the MOV32.
Note
An address loaded in this way is fixed at link time, so the code is not position-independent.
MOV32 sets the Thumb bit (bit 0) of the address if the label referenced is in Thumb code.
Architectures
This pseudo-instruction is available in ARMv6T2 and above in both ARM and Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.58 MOVT
Move Top.
Syntax
MOVT{cond} Rd, #imm16
where:
cond
is an optional condition code.
Rd
is the destination register.
imm16
is a 16-bit immediate value.
Usage
MOVT writes imm16 to Rd[31:16], without affecting Rd[15:0].
You can generate any 32-bit immediate with a MOV, MOVT instruction pair. The assembler
implements the MOV32 pseudo-instruction for convenient generation of this instruction pair.
Register restrictions
You cannot use PC in ARM or Thumb instructions.
You can use SP for Rd in ARM instructions but this is deprecated.
You cannot use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.57 MOV32 pseudo-instruction on page 10-404.
10.8 Condition codes on page 10-317.
10.59 MRA
Transfer between two general-purpose registers and a 40-bit internal accumulator.
Syntax
MRA{cond} RdLo, RdHi, Acc
where:
cond
is an optional condition code.
Acc
is the internal accumulator. The standard name is accx,where x is an integer in the range
0 to n. The value of n depends on the processor. It is 0 for current processors.
RdLo, RdHi
are general-purpose registers. RdLo and RdHi must not be the PC, and they must be
different registers.
Operation
The MRA instruction:
• Copies bits[31:0] of Acc to RdLo.
• Copies bits[39:32] of Acc to RdHi bits[7:0].
• Sign extends the value by copying bit[39] of Acc to bits[31:8] of RdHi.
Architectures
The MRA ARM coprocessor 0 instruction is only available in XScale processors.
There is no Thumb version of the MRA instruction.
Examples
Related references
10.8 Condition codes on page 10-317.
Syntax
MRC{cond} coproc, #opcode1, Rt, CRn, CRm{, #opcode2}
MRC2{cond} coproc, #opcode1, Rt, CRn, CRm{, #opcode2}
where:
cond
is an optional condition code. In ARM code, cond is not permitted for MRC2.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
opcode1
is a 3-bit coprocessor-specific opcode.
opcode2
is an optional 3-bit coprocessor-specific opcode.
Rt
is the ARM destination register. Rt must not be PC.
Rt can be APSR_nzcv. This means that the coprocessor executes an instruction that
changes the value of the condition flags in the APSR.
CRn, CRm
are coprocessor registers.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
Architectures
The MRC ARM instruction is available in all versions of the ARM architecture.
The MRC2 ARM instruction is available in ARMv5T and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no 16-bit versions of these instructions in Thumb.
Related references
10.8 Condition codes on page 10-317.
Syntax
MRRC{cond} coproc, #opcode, Rt, Rt2, CRm
MRRC2{cond} coproc, #opcode, Rt, Rt2, CRm
where:
cond
is an optional condition code. In ARM code, cond is not permitted for MRRC2.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
opcode
is a 4-bit coprocessor-specific opcode.
Rt, Rt2
are ARM destination registers. Rt and Rt2 must not be PC.
CRm
is a coprocessor register.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
Architectures
The MRRC ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
The MRRC2 ARM instruction is available in ARMv6 and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no 16-bit versions of these instructions in Thumb.
Related references
10.8 Condition codes on page 10-317.
Syntax
MRS{cond} Rd, psr
where:
cond
is an optional condition code.
Rd
is the destination register.
psr
is one of:
APSR
on any processor, in any mode.
CPSR
deprecated synonym for APSR and for use in Debug state, on any processor
except ARMv7-M and ARMv6-M.
SPSR
on any processor except ARMv7-M and ARMv6-M, in privileged software
execution only.
Mpsr
on ARMv7-M and ARMv6-M processors only.
Mpsr
can be any of: IPSR, EPSR, IEPSR, IAPSR, EAPSR, MSP, PSP, XPSR, PRIMASK,
BASEPRI, BASEPRI_MAX, FAULTMASK, or CONTROL.
Usage
Use MRS in combination with MSR as part of a read-modify-write sequence for updating a PSR, for
example to change processor mode, or to clear the Q flag.
In process swap code, the programmers’ model state of the process being swapped out must be
saved, including relevant PSR contents. Similarly, the state of the process being swapped in must
also be restored. These operations make use of MRS/store and load/MSR instruction sequences.
SPSR
You must not attempt to access the SPSR when the processor is in User or System mode. This is
your responsibility. The assembler cannot warn you about this, because it has no information
about the processor mode at execution time.
CPSR
ARM deprecates reading the CPSR endianness bit (E) with an MRS instruction.
The CPSR execution state bits, other than the E bit, can only be read when the processor is in
Debug state, halting debug-mode. Otherwise, the execution state bits in the CPSR read as zero.
The condition flags can be read in any mode on any processor. Use APSR if you are only
interested in accessing the condition flags in User mode.
Register restrictions
You cannot use PC for Rd in ARM instructions. You can use SP for Rd in ARM instructions but
this is deprecated in ARMv6T2 and above.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.18 Current Program Status Register on page 2-53.
Related references
10.63 MRS (system coprocessor register to ARM register) on page 10-411.
10.64 MSR (ARM register to system coprocessor register) on page 10-412.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.8 Condition codes on page 10-317.
Syntax
MRS{cond} Rn, coproc_register
MRS{cond} APSR_nzcv, special_register
where:
cond
is an optional condition code.
coproc_register
is the name of the coprocessor register.
special_register
is the name of the coprocessor register that can be written to APSR_nzcv. This is only
possible for the coprocessor register DBGDSCRint.
Rn
is the ARM destination register. Rn must not be PC.
Usage
You can use this pseudo-instruction to read CP14 or CP15 coprocessor registers, with the
exception of write-only registers. A complete list of the applicable coprocessor register names is
in the ARMv7-AR Architecture Reference Manual. For example:
Architectures
This pseudo-instruction is available in ARMv7-A and ARMv7-R in ARM and 32-bit Thumb code.
There is no 16-bit version of this pseudo-instruction in Thumb.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.64 MSR (ARM register to system coprocessor register) on page 10-412.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.8 Condition codes on page 10-317.
Related information
ARM Architecture Reference Manual.
Syntax
MSR{cond} coproc_register, Rn
where:
cond
is an optional condition code.
coproc_register
is the name of the coprocessor register.
Rn
is the ARM source register. Rn must not be PC.
Usage
You can use this pseudo-instruction to write to any CP14 or CP15 coprocessor writable register. A
complete list of the applicable coprocessor register names is in the ARMv7-AR Architecture
Reference Manual. For example:
Architectures
This pseudo-instruction is available in ARMv7-A and ARMv7-R in ARM and 32-bit Thumb code.
There is no 16-bit version of this pseudo-instruction in Thumb.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.63 MRS (system coprocessor register to ARM register) on page 10-411.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.8 Condition codes on page 10-317.
10.149 SYS on page 10-535.
Related information
ARM Architecture Reference Manual.
Syntax
MSR{cond} APSR_flags, Rm
where:
cond
is an optional condition code.
flags
specifies the APSR flags to be moved. flags can be one or more of:
nzcvq
ALU flags field mask, PSR[31:27] (User mode)
g
SIMD GE flags field mask, PSR[19:16] (User mode).
Rm
is the source register. Rm must not be PC.
Syntax
You can also use the following syntax on architectures other than ARMv7-M and ARMv6-M:
MSR{cond} APSR_flags, #constant
MSR{cond} psr_fields, #constant
MSR{cond} psr_fields, Rm
where:
cond
is an optional condition code.
flags
specifies the APSR flags to be moved. flags can be one or more of:
nzcvq
ALU flags field mask, PSR[31:27] (User mode)
g
SIMD GE flags field mask, PSR[19:16] (User mode).
constant
is an expression evaluating to a numeric value. The value must correspond to an 8-bit
pattern rotated by an even number of bits within a 32-bit word. Not available in Thumb.
Rm
is the source register. Rm must not be PC.
psr
is one of:
CPSR
for use in Debug state, also deprecated synonym for APSR
SPSR
on any processor, in privileged software execution only.
fields
specifies the SPSR or CPSR fields to be moved. fields can be one or more of:
c
control field mask byte, PSR[7:0] (privileged software execution)
x
extension field mask byte, PSR[15:8] (privileged software execution)
s
status field mask byte, PSR[23:16] (privileged software execution)
f
flags field mask byte, PSR[31:24] (privileged software execution).
Syntax
You can also use the following syntax on ARMv7-M and ARMv6-M only:
MSR{cond} psr, Rm
where:
cond
is an optional condition code.
Rm
is the source register. Rm must not be PC.
psr
can be any of: APSR, IPSR, EPSR, IEPSR, IAPSR, EAPSR, XPSR, MSP, PSP, PRIMASK,
BASEPRI, BASEPRI_MAX, FAULTMASK, or CONTROL.
Usage
In User mode:
• Use APSR to access the condition flags, Q, or GE bits.
• Writes to unallocated, privileged or execution state bits in the CPSR are ignored. This ensures
that User mode programs cannot change to privileged software execution.
ARM deprecates using MSR to change the endianness bit (E) of the CPSR, in any mode.
You must not attempt to access the SPSR when the processor is in User or System mode.
Register restrictions
You cannot use PC in ARM instructions. You can use SP for Rm in ARM instructions but this is
deprecated in ARMv6T2 and above.
You cannot use PC or SP in Thumb instructions.
Condition flags
This instruction updates the flags explicitly if the APSR_nzcvq or CPSR_f field is specified.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.63 MRS (system coprocessor register to ARM register) on page 10-411.
10.64 MSR (ARM register to system coprocessor register) on page 10-412.
10.8 Condition codes on page 10-317.
10.66 MUL
Multiply with signed or unsigned 32-bit operands, giving the least significant 32 bits of the result.
Syntax
MUL{S}{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rn, Rm
are registers holding the values to be multiplied.
Operation
The MUL instruction multiplies the values from Rn and Rm, and places the least significant 32 bits
of the result in Rd.
Register restrictions
Rn must be different from Rd in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, the MUL instruction:
• Updates the N and Z flags according to the result.
• Corrupts the C and V flag in ARMv4.
• Does not affect the C or V flag in ARMv5T and above.
16-bit instructions
The following forms of the MUL instruction are available in Thumb code, and are 16-bit
instructions:
MULS Rd, Rn, Rd
Rd and Rn must both be Lo registers. This form can only be used outside an IT block.
MUL{cond} Rd, Rn, Rd
Rd and Rn must both be Lo registers. This form can only be used inside an IT block.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
MUL is available in a 32-bit encoding in Thumb in ARMv6T2 and above. MULS is not available in
a 32-bit encoding in Thumb.
This 16-bit Thumb instruction is available in all T variants of the ARM architecture.
Examples
Related references
10.8 Condition codes on page 10-317.
10.67 MVN
Move Not.
Syntax
MVN{S}{cond} Rd, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Operand2
is a flexible second operand.
Operation
The MVN instruction takes the value of Operand2, performs a bitwise logical NOT operation on
the value, and places the result into Rd.
In certain circumstances, the assembler can substitute MVN for MOV, or MOV for MVN. Be aware of
this when reading disassembly listings.
Note
• The deprecation of PC and SP in ARM instructions only applies to ARMv6T2 and above.
If you use PC as Rm, the value used is the address of the instruction plus 8.
If you use PC as Rd:
• Execution branches to the address corresponding to the result.
• If you use the S suffix, see the SUBS pc,lr instruction.
Condition flags
If S is specified, the instruction:
• Updates the N and Z flags according to the result.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
MVNS Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
MVN{cond} Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in all T variants of the ARM architecture.
Example
Incorrect example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
Syntax
NEG{cond} Rd, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register containing the value that is subtracted from zero.
Operation
The NEG pseudo-instruction negates the value in one register and stores the result in a second
register.
NEG{cond} Rd, Rm assembles to RSBS{cond} Rd, Rm, #0.
Architectures
The ARM encoding of this pseudo-instruction is available in all versions of the ARM architecture.
The 32-bit Thumb encoding of this pseudo-instruction is available in ARMv6T2 and later.
Register restrictions
In ARM instructions, using SP or PC for Rd or Rm is deprecated. In Thumb instructions, you
cannot use SP or PC for Rd or Rm.
Condition flags
This pseudo-instruction updates the condition flags, based on the result.
Related references
10.10 ADD on page 10-320.
10.69 NOP
No Operation.
Syntax
NOP{cond}
where:
cond
is an optional condition code.
Usage
NOP does nothing. If NOP is not implemented as a specific instruction on your target architecture,
the assembler treats it as a pseudo-instruction and generates an alternative instruction that does
nothing, such as MOV r0, r0 (ARM) or MOV r8, r8 (Thumb).
NOP is not necessarily a time-consuming NOP. The processor might remove it from the pipeline
before it reaches the execution stage.
You can use NOP for padding, for example to place the following instruction on a 64-bit boundary
in ARM, or a 32-bit boundary in Thumb.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6T2 and above.
NOP is available on all other ARM and Thumb architectures as a pseudo-instruction.
Related references
10.8 Condition codes on page 10-317.
Syntax
ORN{S}{cond} Rd, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The ORN Thumb instruction performs an OR operation on the bits in Rn with the complements of
the corresponding bits in the value of Operand2.
In certain circumstances, the assembler can substitute ORN for ORR, or ORR for ORN. Be aware of
this when reading disassembly listings.
Use of PC
You cannot use PC (R15) for Rd or any operand in the ORN instruction.
Condition flags
If S is specified, the ORN instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
Examples
Architectures
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no ARM or 16-bit Thumb ORN instruction.
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.71 ORR
Logical OR.
Syntax
ORR{S}{cond} Rd, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The ORR instruction performs bitwise OR operations on the values in Rn and Operand2.
In certain circumstances, the assembler can substitute ORN for ORR, or ORR for ORN. Be aware of
this when reading disassembly listings.
Condition flags
If S is specified, the ORR instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following forms of the ORR instruction are available in Thumb code, and are 16-bit
instructions:
ORRS Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
Example
ORREQ r2,r0,r5
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
Syntax
PKHBT{cond} {Rd}, Rn, Rm{, LSL #leftshift}
PKHTB{cond} {Rd}, Rn, Rm{, ASR #rightshift}
where:
PKHBT
Combines bits[15:0] of Rn with bits[31:16] of the shifted value from Rm.
PKHTB
Combines bits[31:16] of Rn with bits[15:0] of the shifted value from Rm.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Rm
is the register holding the first operand.
leftshift
is in the range 0 to 31.
rightshift
is in the range 1 to 32.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
These instructions do not change the flags.
Architectures
These ARM instructions are available in ARMv6 and above.
These 32-bit Thumb instructions are available in ARMv6T2 and above. For the ARMv7-M
architecture, they are only available in an ARMv7E-M implementation.
There are no 16-bit versions of these instructions in Thumb.
Examples
You can also scale the second operand by using different values of shift.
Incorrect examples
PKHBTEQ r4, r5, r1, ASR #8 ; ASR not permitted with PKHBT
Related references
10.8 Condition codes on page 10-317.
Syntax
PLtype{cond} [Rn {, #offset}]
PLtype{cond} [Rn, ±Rm {, shift}]
PLtype{cond} label
where:
type
can be one of:
D
Data address.
DW
Data address with intention to write.
I
Instruction address.
type cannot be DW if the syntax specifies label.
cond
is an optional condition code.
Note
cond is permitted only in Thumb code, using a preceding IT instruction. This is an
unconditional instruction in ARM code and you must not use cond.
Rn
is the register on which the memory address is based.
offset
is an immediate offset. If offset is omitted, the address is the value in Rn.
Rm
is a register containing a value to be used as the offset.
shift
is an optional shift.
label
is a PC-relative expression.
Range of offsets
The offset is applied to the value in Rn before the preload takes place. The result is used as the
memory address for the preload. The range of offsets permitted is:
• –4095 to +4095 for ARM instructions.
• –255 to +4095 for Thumb instructions, when Rn is not PC.
• –4095 to +4095 for Thumb instructions, when Rn is PC.
The assembler calculates the offset from the PC for you. The assembler generates an error if
label is out of range.
Register restrictions
Rm must not be PC. For Thumb instructions Rm must also not be SP.
Rn must not be PC for Thumb instructions of the syntax PLtype{cond} [Rn, ±Rm{,
#shift}].
Architectures
ARM PLD is available in ARMv5TE and above.
The 32-bit Thumb encoding of PLD is available in ARMv6T2 and above.
PLDW is available only in ARMv7 and above that implement the Multiprocessing Extensions.
PLI is available only in ARMv7 and above.
There are no 16-bit encodings of PLD, PLDW, or PLI in Thumb.
These are hint instructions, and their implementation is optional. If they are not implemented, they
execute as NOPs.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
10.74 POP
Pop registers off a full descending stack.
Syntax
POP{cond} reglist
where:
cond
is an optional condition code.
reglist
is a non-empty list of registers, enclosed in braces. It can contain register ranges. It must
be comma separated if it contains more than one register or register range.
Operation
POP is a synonym for LDMIA sp! reglist. POP is the preferred mnemonic.
Note
LDM and LDMFD are synonyms of LDMIA.
Registers are stored on the stack in numerical order, with the lowest numbered register at the
lowest address.
Thumb instructions
A subset of these instructions are available in the Thumb instruction set.
The following restriction applies to the 16-bit POP instruction:
• reglist can only include the Lo registers and the PC.
The following restrictions apply to the 32-bit POP instruction:
• reglist must not include the SP.
• reglist can include either the LR or the PC, but not both.
Example
Related references
10.40 LDM on page 10-370.
10.8 Condition codes on page 10-317.
10.75 PUSH
Push registers onto a full descending stack.
Syntax
PUSH{cond} reglist
where:
cond
is an optional condition code.
reglist
is a non-empty list of registers, enclosed in braces. It can contain register ranges. It must
be comma separated if it contains more than one register or register range.
Operation
PUSH is a synonym for STMDB sp!, reglist. PUSH is the preferred mnemonic.
Note
STMFD is a synonym of STMDB.
Registers are stored on the stack in numerical order, with the lowest numbered register at the
lowest address.
Thumb instructions
The following restriction applies to the 16-bit PUSH instruction:
• reglist can only include the Lo registers and the LR.
The following restrictions apply to the 32-bit PUSH instruction:
• reglist must not include the SP.
• reglist must not include the PC.
Examples
PUSH {r0,r4-r7}
PUSH {r2,lr}
Related references
10.40 LDM on page 10-370.
10.8 Condition codes on page 10-317.
10.76 QADD
Signed saturating addition.
Syntax
QADD{cond} {Rd}, Rm, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the registers holding the operands.
Operation
The QADD instruction adds the values in Rm and Rn. It saturates the result to the signed range –231
≤ x ≤ 231–1.
Note
All values are treated as two’s complement signed integers by this instruction.
Register restrictions
You cannot use PC for any operand.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.77 QADD8
Signed saturating parallel byte-wise addition.
Syntax
QADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four signed integer additions on the corresponding bytes of the operands
and writes the results into the corresponding bytes of the destination. It saturates the results to the
signed range –27 ≤ x ≤ 27 –1. The Q flag is not affected even if this operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.78 QADD16
Signed saturating parallel halfword-wise addition.
Syntax
QADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two signed integer additions on the corresponding halfwords of the
operands and writes the results into the corresponding halfwords of the destination. It saturates the
results to the signed range –215 ≤ x ≤ 215 –1. The Q flag is not affected even if this operation
saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.79 QASX
Signed saturating parallel add and subtract halfwords with exchange.
Syntax
QASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It writes the
results into the corresponding halfwords of the destination. It saturates the results to the signed
range –215 ≤ x ≤ 215 –1. The Q flag is not affected even if this operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.80 QDADD
Signed saturating Double and Add.
Syntax
QDADD{cond} {Rd}, Rm, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the registers holding the operands.
Operation
QDADD calculates SAT(Rm + SAT(Rn * 2)). It saturates the result to the signed range –231 ≤ x
≤ 231–1. Saturation can occur on the doubling operation, on the addition, or on both. If saturation
occurs on the doubling but not on the addition, the Q flag is set but the final result is unsaturated.
Note
All values are treated as two’s complement signed integers by this instruction.
Register restrictions
You cannot use PC for any operand.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.81 QDSUB
Signed saturating Double and Subtract.
Syntax
QDSUB{cond} {Rd}, Rm, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the registers holding the operands.
Operation
QDSUB calculates SAT(Rm - SAT(Rn * 2)). It saturates the result to the signed range –231 ≤ x
≤ 231–1. Saturation can occur on the doubling operation, on the subtraction, or on both. If
saturation occurs on the doubling but not on the subtraction, the Q flag is set but the final result is
unsaturated.
Note
All values are treated as two’s complement signed integers by this instruction.
Register restrictions
You cannot use PC for any operand.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it are only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.82 QSAX
Signed saturating parallel subtract and add halfwords with exchange.
Syntax
QSAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It writes
the results into the corresponding halfwords of the destination. It saturates the results to the signed
range –215 ≤ x ≤ 215 –1. The Q flag is not affected even if this operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.83 QSUB
Signed saturating Subtract.
Syntax
QSUB{cond} {Rd}, Rm, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the registers holding the operands.
Operation
The QSUB instruction subtracts the value in Rn from the value in Rm. It saturates the result to the
signed range –231 ≤ x ≤ 231–1.
Note
All values are treated as two’s complement signed integers by this instruction.
Register restrictions
You cannot use PC for any operand.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.84 QSUB8
Signed saturating parallel byte-wise subtraction.
Syntax
QSUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand and writes the results into the corresponding bytes of the destination. It saturates the
results to the signed range –27 ≤ x ≤ 27 –1. The Q flag is not affected even if this operation
saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.85 QSUB16
Signed saturating parallel halfword-wise subtraction.
Syntax
QSUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand and writes the results into the corresponding halfwords of the destination. It
saturates the results to the signed range –215 ≤ x ≤ 215 –1. The Q flag is not affected even if this
operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related concepts
2.17 The Q flag on page 2-52.
Related references
10.8 Condition codes on page 10-317.
10.86 RBIT
Reverse the bit order in a 32-bit word.
Syntax
RBIT{cond} Rd, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the operand.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6 and above.
Example
RBIT r7, r8
Related references
10.8 Condition codes on page 10-317.
10.87 REV
Reverse the byte order in a word.
Syntax
REV{cond} Rd, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the operand.
Usage
You can use this instruction to change endianness. REV converts 32-bit big-endian data into little-
endian data or 32-bit little-endian data into big-endian data.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
REV Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6 and above.
Example
REV r3, r7
Related references
10.8 Condition codes on page 10-317.
10.88 REV16
Reverse the byte order in each halfword independently.
Syntax
REV16{cond} Rd, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the operand.
Usage
You can use this instruction to change endianness. REV16 converts 16-bit big-endian data into
little-endian data or 16-bit little-endian data into big-endian data.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
REV16 Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6 and above.
Example
REV16 r0, r0
Related references
10.8 Condition codes on page 10-317.
10.89 REVSH
Reverse the byte order in the bottom halfword, and sign extend to 32 bits.
Syntax
REVSH{cond} Rd, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the operand.
Usage
You can use this instruction to change endianness. REVSH converts either:
• 16-bit signed big-endian data into 32-bit signed little-endian data.
• 16-bit signed little-endian data into 32-bit signed big-endian data.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
REVSH Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6 and above.
Example
Related references
10.8 Condition codes on page 10-317.
10.90 RFE
Return From Exception.
Syntax
RFE{addr_mode}{cond} Rn{!}
where:
addr_mode
is any one of the following:
IA
Increment address After each transfer (Full Descending stack)
IB
Increment address Before each transfer (ARM only)
DA
Decrement address After each transfer (ARM only)
DB
Decrement address Before each transfer.
If addr_mode is omitted, it defaults to Increment After.
cond
is an optional condition code.
Note
cond is permitted only in Thumb code, using a preceding IT instruction. This is an
unconditional instruction in ARM code.
Rn
specifies the base register. Rn must not be PC.
!
is an optional suffix. If ! is present, the final address is written back into Rn.
Usage
You can use RFE to return from an exception if you previously saved the return state using the
SRS instruction. Rn is usually the SP where the return state information was saved.
Operation
Loads the PC and the CPSR from the address contained in Rn, and the following address.
Optionally updates Rn.
Notes
RFE writes an address to the PC. The alignment of this address must be correct for the instruction
set in use after the exception return:
• For a return to ARM, the address written to the PC must be word-aligned.
• For a return to Thumb, the address written to the PC must be halfword-aligned.
• For a return to Jazelle, there are no alignment restrictions on the address written to the PC.
No special precautions are required in software to follow these rules, if you use the instruction to
return after a valid exception entry mechanism.
Where addresses are not word-aligned, RFE ignores the least significant two bits of Rn.
The time order of the accesses to individual words of memory generated by RFE is not
architecturally defined. Do not use this instruction on memory-mapped I/O locations where access
order matters.
Do not use RFE in unprivileged software execution.
Do not use RFE in ThumbEE.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above, except the ARMv7-M
architecture.
There is no 16-bit version of this instruction.
Example
RFE sp!
Related concepts
2.4 Processor modes, and privileged and unprivileged software execution on page 2-38.
Related references
10.127 SRS on page 10-495.
10.8 Condition codes on page 10-317.
10.91 ROR
Rotate Right. This instruction is a preferred synonym for MOV instructions with shifted register
operands.
Syntax
ROR{S}{cond} Rd, Rm, Rs
ROR{S}{cond} Rd, Rm, #sh
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rm
is the register holding the first operand. This operand is shifted right.
Rs
is a register holding a shift value to apply to the value in Rm. Only the least significant
byte is used.
sh
is a constant shift. The range of values is 1-31.
Operation
ROR provides the value of the contents of a register rotated by a value. The bits that are rotated off
the right end are inserted into the vacated bit positions on the left.
Note
The ARM instruction RORS{cond} pc,Rm,#sh always disassembles to the preferred form
MOVS{cond} pc,Rm{,shift}.
Caution
Do not use the S suffix when using PC as Rd in User mode or System mode. The assembler cannot
warn you about this because it has no information about what the processor mode is likely to be at
execution time.
You cannot use PC for Rd or any operand in this instruction if it has a register-controlled shift.
Condition flags
If S is specified, the instruction updates the N and Z flags according to the result.
The C flag is unaffected if the shift value is 0. Otherwise, the C flag is updated to the last bit
shifted out.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
RORS Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used outside an IT block.
ROR{cond} Rd, Rd, Rs
Rd and Rs must both be Lo registers. This form can only be used inside an IT block.
Architectures
This ARM instruction is available in all architectures.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv4T and above.
Example
Related references
10.56 MOV on page 10-402.
10.8 Condition codes on page 10-317.
10.92 RRX
Rotate Right with Extend. This instruction is a preferred synonym for MOV instructions with
shifted register operands.
Syntax
RRX{S}{cond} Rd, Rm
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
Rd
is the destination register.
Rm
is the register holding the first operand. This operand is shifted right.
Operation
RRX provides the value of the contents of a register shifted right one bit. The old carry flag is
shifted into bit[31]. If the S suffix is present, the old bit[0] is placed in the carry flag.
Note
The ARM instruction RRXS{cond} pc,Rm always disassembles to the preferred form
MOVS{cond} pc,Rm{,shift}.
Caution
Do not use the S suffix when using PC as Rd in User mode or System mode. The assembler cannot
warn you about this because it has no information about what the processor mode is likely to be at
execution time.
You cannot use PC for Rd or any operand in this instruction if it has a register-controlled shift.
Condition flags
If S is specified, the instruction updates the N and Z flags according to the result.
The C flag is unaffected if the shift value is 0. Otherwise, the C flag is updated to the last bit
shifted out.
Architectures
This ARM instruction is available in all architectures.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit RRX instruction in Thumb.
Related references
10.56 MOV on page 10-402.
10.8 Condition codes on page 10-317.
10.93 RSB
Reverse Subtract without carry.
Syntax
RSB{S}{cond} {Rd}, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Operation
The RSB instruction subtracts the value in Rn from the value of Operand2. This is useful because
of the wide range of options for Operand2.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, the RSB instruction updates the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
Example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.94 RSC
Reverse Subtract with Carry.
Syntax
RSC{S}{cond} {Rd}, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Usage
The RSC instruction subtracts the value in Rn from the value of Operand2. If the carry flag is
clear, the result is reduced by one.
You can use RSC to synthesize multiword arithmetic.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, the RSC instruction updates the N, Z, C and V flags according to the result.
Example
Incorrect example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.95 SADD8
Signed parallel byte-wise addition.
Syntax
SADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four signed integer additions on the corresponding bytes of the operands
and writes the results into the corresponding bytes of the destination. The results are modulo 28. It
sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[0]
for bits[7:0] of the result.
GE[1]
for bits[15:8] of the result.
GE[2]
for bits[23:16] of the result.
GE[3]
for bits[31:24] of the result.
It sets a GE flag to 1 to indicate that the corresponding result is greater than or equal to zero. This
is equivalent to an ADDS instruction setting the N and V condition flags to the same value, so that
the GE condition passes.
You can use these flags to control a following SEL instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.96 SADD16
Signed parallel halfword-wise addition.
Syntax
SADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two signed integer additions on the corresponding halfwords of the
operands and writes the results into the corresponding halfwords of the destination. The results are
modulo 216. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result is greater than or equal to
zero. This is equivalent to an ADDS instruction setting the N and V condition flags to the same
value, so that the GE condition passes.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.97 SASX
Signed parallel add and subtract halfwords with exchange.
Syntax
SASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It writes the
results into the corresponding halfwords of the destination. The results are modulo 216. It sets the
APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result is greater than or equal to
zero. This is equivalent to an ADDS or SUBS instruction setting the N and V condition flags to the
same value, so that the GE condition passes.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.98 SBC
Subtract with Carry.
Syntax
SBC{S}{cond} {Rd}, Rn, Operand2
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
Usage
The SBC (Subtract with Carry) instruction subtracts the value of Operand2 from the value in Rn.
If the carry flag is clear, the result is reduced by one.
You can use SBC to synthesize multiword arithmetic.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, the SBC instruction updates the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
SBCS Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used outside an IT block.
SBC{cond} Rd, Rd, Rm
Rd and Rm must both be Lo registers. This form can only be used inside an IT block.
For clarity, the above examples use consecutive registers for multiword values. There is no
requirement to do this. The following, for example, is perfectly valid:
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
10.99 SBFX
Signed Bit Field Extract.
Syntax
SBFX{cond} Rd, Rn, #lsb, #width
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the source register.
lsb
is the bit number of the least significant bit in the bitfield, in the range 0 to 31.
width
is the width of the bitfield, in the range 1 to (32–lsb).
Operation
Copies adjacent bits from one register into the least significant bits of a second register, and sign
extends to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in the ARM instruction but this is deprecated in ARMv6T2 and above. You
cannot use SP in the Thumb instruction.
Condition flags
This instruction does not alter any flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.100 SDIV
Signed Divide.
Syntax
SDIV{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the value to be divided.
Rm
is a register holding the divisor.
Register restrictions
PC or SP cannot be used for Rd, Rn or Rm.
Architectures
This 32-bit Thumb instruction is available in ARMv7-R and ARMv7-M only.
There is no ARM or 16-bit Thumb SDIV instruction.
Related references
10.8 Condition codes on page 10-317.
10.101 SEL
Select bytes from each operand according to the state of the APSR GE flags.
Syntax
SEL{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Rm
is the register holding the second operand.
Operation
The SEL instruction selects bytes from Rn or Rm according to the APSR GE flags:
• If GE[0] is set, Rd[7:0] come from Rn[7:0], otherwise from Rm[7:0].
• If GE[1] is set, Rd[15:8] come from Rn[15:8], otherwise from Rm[15:8].
• If GE[2] is set, Rd[23:16] come from Rn[23:16], otherwise from Rm[23:16].
• If GE[3] is set, Rd[31:24] come from Rn[31:24], otherwise from Rm[31:24].
Usage
Use the SEL instruction after one of the signed parallel instructions. You can use this to select
maximum or minimum values in multiple byte or halfword data.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
The following instruction sequence sets each byte in R4 equal to the unsigned minimum of the
corresponding bytes of R1 and R2:
Related concepts
2.16 Application Program Status Register on page 2-51.
Related references
10.8 Condition codes on page 10-317.
10.102 SETEND
Set the endianness bit in the CPSR, without affecting any other bits in the CPSR.
Syntax
SETEND specifier
where:
specifier
is one of:
BE
Big-endian.
LE
Little-endian.
Usage
Use SETEND to access data of different endianness, for example, to access several big-endian
DMA-formatted data fields from an otherwise little-endian application.
SETEND cannot be conditional, and is not permitted in an IT block.
Architectures
This ARM instruction is available in ARMv6 and above.
This 16-bit Thumb instruction is available in T variants of ARMv6 and above, except the
ARMv6-M and ARMv7-M architectures.
There is no 32-bit version of this instruction in Thumb.
Example
10.103 SEV
Set Event.
Syntax
SEV{cond}
where:
cond
is an optional condition code.
Operation
This is a hint instruction. It is optional whether it is implemented or not. If it is not implemented, it
executes as a NOP. The assembler produces a diagnostic message if the instruction executes as a
NOP on the target.
SEV executes as a NOP instruction in ARMv6T2.
SEV causes an event to be signaled to all cores within a multiprocessor system. If SEV is
implemented, WFE must also be implemented.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6T2 and above.
Related references
10.69 NOP on page 10-420.
10.8 Condition codes on page 10-317.
10.104 SHADD8
Signed halving parallel byte-wise addition.
Syntax
SHADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four signed integer additions on the corresponding bytes of the
operands, halves the results, and writes the results into the corresponding bytes of the destination.
This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.105 SHADD16
Signed halving parallel halfword-wise addition.
Syntax
SHADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two signed integer additions on the corresponding halfwords of the
operands, halves the results, and writes the results into the corresponding halfwords of the
destination. This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.106 SHASX
Signed halving parallel add and subtract halfwords with exchange.
Syntax
SHASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It halves the
results and writes them into the corresponding halfwords of the destination. This cannot cause
overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.107 SHSAX
Signed halving parallel subtract and add halfwords with exchange.
Syntax
SHSAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It halves
the results and writes them into the corresponding halfwords of the destination. This cannot cause
overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.108 SHSUB8
Signed halving parallel byte-wise subtraction.
Syntax
SHSUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand, halves the results, and writes the results into the corresponding bytes of the destination.
This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.109 SHSUB16
Signed halving parallel halfword-wise subtraction.
Syntax
SHSUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand, halves the results, and writes the results into the corresponding halfwords of
the destination. This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.110 SMC
Secure Monitor Call.
Syntax
SMC{cond} #imm4
where:
cond
is an optional condition code.
imm4
is a 4-bit immediate value. This is ignored by the ARM processor, but can be used by the
SMC exception handler to determine what service is being requested.
Note
SMC was called SMI in earlier versions of the ARM assembly language. SMI instructions
disassemble to SMC, with a comment to say that this was formerly SMI.
Architectures
This ARM instruction is available in implementations of ARMv6 and above, if they have the
Security Extensions.
This 32-bit Thumb instruction is available in implementations of ARMv6T2 and above, if they
have the Security Extensions.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
Related information
ARM Architecture Reference Manual.
10.111 SMLAxy
Signed Multiply Accumulate, with 16-bit operands and a 32-bit result and accumulator.
Syntax
SMLA<x><y>{cond} Rd, Rn, Rm, Ra
where:
<x>
is either B or T. B means use the bottom half (bits [15:0]) of Rn, T means use the top half
(bits [31:16]) of Rn.
<y>
is either B or T. B means use the bottom half (bits [15:0]) of Rm, T means use the top half
(bits [31:16]) of Rm.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the values to be multiplied.
Ra
is the register holding the value to be added.
Operation
SMLAxy multiplies the 16-bit signed integers from the selected halves of Rn and Rm, adds the 32-
bit result to the 32-bit value in Ra, and places the result in Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, or V flags.
If overflow occurs in the accumulation, SMLAxy sets the Q flag. To read the state of the Q flag,
use an MRS instruction.
Note
SMLAxy never clears the Q flag. To clear the Q flag, use an MSR instruction.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.8 Condition codes on page 10-317.
10.112 SMLAD
Dual 16-bit Signed Multiply with Addition of products and 32-bit accumulation.
Syntax
SMLAD{X}{cond} Rd, Rn, Rm, Ra
where:
cond
is an optional condition code.
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Ra
is the register holding the accumulate operand.
Operation
SMLAD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top halfword
of Rn with the top halfword of Rm. It then adds both products to the value in Ra and stores the sum
to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.113 SMLAL
Signed Long Multiply, with optional Accumulate, with 32-bit operands, and 64-bit result and
accumulator.
Syntax
SMLAL{S}{cond} RdLo, RdHi, Rn, Rm
where:
S
is an optional suffix available in ARM state only. If S is specified, the condition flags are
updated on the result of the operation.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers. They also hold the accumulating value. RdLo and RdHi must
be different registers
Rn, Rm
are ARM registers holding the operands.
Operation
The SMLAL instruction interprets the values from Rn and Rm as two’s complement signed integers.
It multiplies these integers, and adds the 64-bit result to the 64-bit signed integer contained in
RdHi and RdLo.
Register restrictions
Rn must be different from RdLo and RdHi in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, this instruction:
• Updates the N and Z flags according to the result.
• Does not affect the C or V flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.114 SMLALD
Dual 16-bit Signed Multiply with Addition of products and 64-bit Accumulation.
Syntax
SMLALD{X}{cond} RdLo, RdHi, Rn, Rm
where:
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers for the 64-bit result. They also hold the 64-bit accumulate
operand. RdHi and RdLo must be different registers.
Rn, Rm
are the registers holding the operands.
Operation
SMLALD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top
halfword of Rn with the top halfword of Rm. It then adds both products to the value in RdLo, RdHi
and stores the sum to RdLo, RdHi.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.115 SMLALxy
Signed Multiply-Accumulate with 16-bit operands and a 64-bit accumulator.
Syntax
SMLAL<x><y>{cond} RdLo, RdHi, Rn, Rm
where:
<x>
is either B or T. B means use the bottom half (bits [15:0]) of Rn, T means use the top half
(bits [31:16]) of Rn.
<y>
is either B or T. B means use the bottom half (bits [15:0]) of Rm, T means use the top half
(bits [31:16]) of Rm.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers. They also hold the accumulate value. RdHi and RdLo must
be different registers.
Rn, Rm
are the registers holding the values to be multiplied.
Operation
SMLALxy multiplies the signed integer from the selected half of Rm by the signed integer from the
selected half of Rn, and adds the 32-bit result to the 64-bit value in RdHi and RdLo.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Note
SMLALxy cannot raise an exception. If overflow occurs on this instruction, the result wraps round
without any warning.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.116 SMLAWy
Signed Multiply-Accumulate Wide, with one 32-bit and one 16-bit operand, providing the top 32
bits of the result.
Syntax
SMLAW<y>{cond} Rd, Rn, Rm, Ra
where:
<y>
is either B or T. B means use the bottom half (bits [15:0]) of Rm, T means use the top half
(bits [31:16]) of Rm.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the values to be multiplied.
Ra
is the register holding the value to be added.
Operation
SMLAWy multiplies the signed integer from the selected half of Rm by the signed integer from Rn,
adds the 32-bit result to the 32-bit value in Ra, and places the result in Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, or V flags.
If overflow occurs in the accumulation, SMLAWy sets the Q flag.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.117 SMLSD
Dual 16-bit Signed Multiply with Subtraction of products and 32-bit accumulation.
Syntax
SMLSD{X}{cond} Rd, Rn, Rm, Ra
where:
cond
is an optional condition code.
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Ra
is the register holding the accumulate operand.
Operation
SMLSD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top halfword
of Rn with the top halfword of Rm. It then subtracts the second product from the first, adds the
difference to the value in Ra, and stores the result to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, this instruction is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.118 SMLSLD
Dual 16-bit Signed Multiply with Subtraction of products and 64-bit accumulation.
Syntax
SMLSD{X}{cond} RdLo, RdHi, Rn, Rm
where:
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers for the 64-bit result. They also hold the 64-bit accumulate
operand. RdHi and RdLo must be different registers.
Rn, Rm
are the registers holding the operands.
Operation
SMLSLD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top
halfword of Rn with the top halfword of Rm. It then subtracts the second product from the first,
adds the difference to the value in RdLo, RdHi, and stores the result to RdLo, RdHi.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.119 SMMLA
Signed Most significant word Multiply with Accumulation.
Syntax
SMMLA{R}{cond} Rd, Rn, Rm, Ra
where:
R
is an optional parameter. If R is present, the result is rounded, otherwise it is truncated.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Ra
is a register holding the value to be added or subtracted from.
Operation
SMMLA multiplies the values from Rn and Rm, adds the value in Ra to the most significant 32 bits
of the product, and stores the result in Rd.
If the optional R parameter is specified, 0x80000000 is added before extracting the most
significant 32 bits. This has the effect of rounding the result.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.120 SMMLS
Signed Most significant word Multiply with Subtraction.
Syntax
SMMLS{R}{cond} Rd, Rn, Rm, Ra
where:
R
is an optional parameter. If R is present, the result is rounded, otherwise it is truncated.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Ra
is a register holding the value to be added or subtracted from.
Operation
SMMLS multiplies the values from Rn and Rm, subtracts the product from the value in Ra shifted
left by 32 bits, and stores the most significant 32 bits of the result in Rd.
If the optional R parameter is specified, 0x80000000 is added before extracting the most
significant 32 bits. This has the effect of rounding the result.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.121 SMMUL
Signed Most significant word Multiply.
Syntax
SMMUL{R}{cond} {Rd}, Rn, Rm
where:
R
is an optional parameter. If R is present, the result is rounded, otherwise it is truncated.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Ra
is a register holding the value to be added or subtracted from.
Operation
SMMUL multiplies the 32-bit values from Rn and Rm, and stores the most significant 32 bits of the
64-bit result to Rd.
If the optional R parameter is specified, 0x80000000 is added before extracting the most
significant 32 bits. This has the effect of rounding the result.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.122 SMUAD
Dual 16-bit Signed Multiply with Addition of products, and optional exchange of operand halves.
Syntax
SMUAD{X}{cond} {Rd}, Rn, Rm
where:
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Operation
SMUAD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top halfword
of Rn with the top halfword of Rm. It then adds the products and stores the sum to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
The SMUAD instruction sets the Q flag if the addition overflows.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.123 SMULxy
Signed Multiply, with 16-bit operands and a 32-bit result and accumulator.
Syntax
SMUL<x><y>{cond} {Rd}, Rn, Rm
where:
<x>
is either B or T. B means use the bottom half (bits [15:0]) of Rn, T means use the top half
(bits [31:16]) of Rn.
<y>
is either B or T. B means use the bottom half (bits [15:0]) of Rm, T means use the top half
(bits [31:16]) of Rm.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the values to be multiplied.
Ra
is the register holding the value to be added.
Operation
SMULxy multiplies the 16-bit signed integers from the selected halves of Rn and Rm, and places the
32-bit result in Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
These instructions do not affect the N, Z, C, or V flags.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.65 MSR (general-purpose register to PSR) on page 10-413.
10.8 Condition codes on page 10-317.
10.124 SMULL
Signed Long Multiply, with 32-bit operands and 64-bit result.
Syntax
SMULL{S}{cond} RdLo, RdHi, Rn, Rm
where:
S
is an optional suffix available in ARM state only. If S is specified, the condition flags are
updated on the result of the operation.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers. RdLo and RdHi must be different registers
Rn, Rm
are ARM registers holding the operands.
Operation
The SMULL instruction interprets the values from Rn and Rm as two’s complement signed integers.
It multiplies these integers and places the least significant 32 bits of the result in RdLo, and the
most significant 32 bits of the result in RdHi.
Register restrictions
Rn must be different from RdLo and RdHi in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, this instruction:
• Updates the N and Z flags according to the result.
• Does not affect the C or V flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.125 SMULWy
Signed Multiply Wide, with one 32-bit and one 16-bit operand, providing the top 32 bits of the
result.
Syntax
SMULW<y>{cond} {Rd}, Rn, Rm
where:
<y>
is either B or T. B means use the bottom half (bits [15:0]) of Rm, T means use the top half
(bits [31:16]) of Rm.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the values to be multiplied.
Ra
is the register holding the value to be added.
Operation
SMULWy multiplies the signed integer from the selected half of Rm by the signed integer from Rn,
and places the upper 32-bits of the 48-bit result in Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, or V flags.
Architectures
This ARM instruction is available in ARMv6 and above, and E variants of ARMv5T.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.126 SMUSD
Dual 16-bit Signed Multiply with Subtraction of products, and optional exchange of operand
halves.
Syntax
SMUSD{X}{cond} {Rd}, Rn, Rm
where:
X
is an optional parameter. If X is present, the most and least significant halfwords of the
second operand are exchanged before the multiplications occur.
cond
is an optional condition code.
Rd
is the destination register.
Rn, Rm
are the registers holding the operands.
Operation
SMUSD multiplies the bottom halfword of Rn with the bottom halfword of Rm, and the top halfword
of Rn with the top halfword of Rm. It then subtracts the second product from the first, and stores
the difference to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.127 SRS
Store Return State onto a stack.
Syntax
SRS{addr_mode}{cond} sp{!}, #modenum
SRS{addr_mode}{cond} #modenum{!} ; This is pre-UAL syntax
where:
addr_mode
is any one of the following:
IA
Increment address After each transfer
IB
Increment address Before each transfer (ARM only)
DA
Decrement address After each transfer (ARM only)
DB
Decrement address Before each transfer (Full Descending stack).
If addr_mode is omitted, it defaults to Increment After. You can also use stack oriented
addressing mode suffixes, for example, when implementing stacks.
cond
is an optional condition code.
Note
cond is permitted only in Thumb code, using a preceding IT instruction. This is an
unconditional instruction in ARM.
!
is an optional suffix. If ! is present, the final address is written back into the SP of the
mode specified by modenum.
modenum
specifies the number of the mode whose banked SP is used as the base register. You must
use only the defined mode numbers.
Operation
SRS stores the LR and the SPSR of the current mode, at the address contained in SP of the mode
specified by modenum, and the following word respectively. Optionally updates SP of the mode
specified by modenum. This is compatible with the normal use of the STM instruction for stack
accesses.
Note
For full descending stack, you must use SRSFD or SRSDB.
Usage
You can use SRS to store return state for an exception handler on a different stack from the one
automatically selected.
Notes
Where addresses are not word-aligned, SRS ignores the least significant two bits of the specified
address.
The time order of the accesses to individual words of memory generated by SRS is not
architecturally defined. Do not use this instruction on memory-mapped I/O locations where access
order matters.
Do not use SRS in User and System modes because these modes do not have a SPSR.
Do not use SRS in ThumbEE.
SRS is not permitted in a non-secure state if modenum specifies monitor mode.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above, except the ARMv7-M
architecture.
There is no 16-bit version of this instruction.
Example
R13_usr EQU 16
SRSFD sp,#R13_usr
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
2.4 Processor modes, and privileged and unprivileged software execution on page 2-38.
Related references
10.40 LDM on page 10-370.
10.8 Condition codes on page 10-317.
10.128 SSAT
Signed Saturate to any bit position, with optional shift before saturating.
Syntax
SSAT{cond} Rd, #sat, Rm{, shift}
where:
cond
is an optional condition code.
Rd
is the destination register.
sat
specifies the bit position to saturate to, in the range 1 to 32.
Rm
is the register containing the operand.
shift
is an optional shift. It must be one of the following:
ASR #n
where n is in the range 1-32 (ARM) or 1-31 (Thumb)
LSL #n
where n is in the range 0-31.
Operation
The SSAT instruction applies the specified shift, then saturates a signed value to the signed range –
2sat–1 ≤ x ≤ 2sat–1 –1.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.129 SSAT16 on page 10-498.
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.129 SSAT16
Parallel halfword Saturate.
Syntax
SSAT16{cond} Rd, #sat, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
sat
specifies the bit position to saturate to, in the range 1 to 16.
Rn
is the register holding the operand.
Operation
Halfword-wise signed saturation to any bit position.
The SSAT16 instruction saturates each signed halfword to the signed range –2sat–1 ≤ x ≤ 2sat–1 –1.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs on either halfword, this instruction sets the Q flag. To read the state of the Q
flag, use an MRS instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Incorrect example
SSAT16 r1, #16, r2, LSL #4 ; shifts not permitted with halfword
; saturations
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.130 SSAX
Signed parallel subtract and add halfwords with exchange.
Syntax
SSAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It writes
the results into the corresponding halfwords of the destination. The results are modulo 216. It sets
the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result is greater than or equal to
zero. This is equivalent to an ADDS or SUBS instruction setting the N and V condition flags to the
same value, so that the GE condition passes.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.131 SSUB8
Signed parallel byte-wise subtraction.
Syntax
SSUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand and writes the results into the corresponding bytes of the destination. The results are
modulo 28. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[0]
for bits[7:0] of the result.
GE[1]
for bits[15:8] of the result.
GE[2]
for bits[23:16] of the result.
GE[3]
for bits[31:24] of the result.
It sets a GE flag to 1 to indicate that the corresponding result is greater than or equal to zero. This
is equivalent to a SUBS instruction setting the N and V condition flags to the same value, so that
the GE condition passes.
You can use these flags to control a following SEL instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.132 SSUB16
Signed parallel halfword-wise subtraction.
Syntax
SSUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand and writes the results into the corresponding halfwords of the destination. The
results are modulo 216. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result is greater than or equal to
zero. This is equivalent to a SUBS instruction setting the N and V condition flags to the same
value, so that the GE condition passes.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
Syntax
op{L}{cond} coproc, CRd, [Rn]
op{L}{cond} coproc, CRd, [Rn, #{-}offset] ; offset addressing
op{L}{cond} coproc, CRd, [Rn, #{-}offset]! ; pre-index addressing
op{L}{cond} coproc, CRd, [Rn], #{-}offset ; post-index addressing
op{L}{cond} coproc, CRd, label
where:
op
is one of STC or STC2.
cond
is an optional condition code.
In ARM code, cond is not permitted for STC2.
L
is an optional suffix specifying a long transfer.
coproc
is the name of the coprocessor the instruction is for. The standard name is pn, where n is
an integer in the range 0 to 15.
CRd
is the coprocessor register to store.
Rn
is the register on which the memory address is based. If PC is specified, the value used is
the address of the current instruction plus eight.
-
is an optional minus sign. If - is present, the offset is subtracted from Rn. Otherwise, the
offset is added to Rn.
offset
is an expression evaluating to a multiple of 4, in the range 0 to 1020.
!
is an optional suffix. If ! is present, the address including the offset is written back into
Rn.
label
is a word-aligned PC-relative expression.
label must be within 1020 bytes of the current instruction.
Usage
The use of these instructions depends on the coprocessor. See the coprocessor documentation for
details.
In ThumbEE, if the value in the base register is zero, execution branches to the NullCheck handler
at HandlerBase - 4.
Architectures
STC is available in all versions of the ARM architecture.
STC2 is available in ARMv5T and above.
Register restrictions
You cannot use PC for Rn in the pre-index and post-index instructions. These are the forms that
write back to Rn.
You cannot use PC for Rn in Thumb STC and STC2 instructions.
ARM STC and STC2 instructions that use the label syntax, or where Rn is PC, are deprecated in
ARMv6T2 and above.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
10.8 Condition codes on page 10-317.
10.134 STM
Store Multiple registers.
Syntax
STM{addr_mode}{cond} Rn{!}, reglist{^}
where:
addr_mode
is any one of the following:
IA
Increment address After each transfer. This is the default, and can be omitted.
IB
Increment address Before each transfer (ARM only).
DA
Decrement address After each transfer (ARM only).
DB
Decrement address Before each transfer.
You can also use the stack-oriented addressing mode suffixes, for example when
implementing stacks.
cond
is an optional condition code.
Rn
is the base register, the ARM register holding the initial address for the transfer. Rn must
not be PC.
!
is an optional suffix. If ! is present, the final address is written back into Rn.
reglist
is a list of one or more registers to be stored, enclosed in braces. It can contain register
ranges. It must be comma-separated if it contains more than one register or register range.
Any combination of registers R0 to R15 (PC) can be transferred in ARM state, but there
are some restrictions in Thumb state.
^
is an optional suffix, available in ARM state only. You must not use it in User mode or
System mode. Data is transferred into or out of the User mode registers instead of the
current mode registers.
16-bit instruction
A 16-bit version of this instruction is available in Thumb code.
The following restrictions apply to the 16-bit instruction:
• All registers in reglist must be Lo registers.
• Rn must be a Lo register.
• addr_mode must be omitted (or IA), meaning increment address after each transfer.
• Writeback must be specified for STM instructions.
Note
16-bit Thumb STM instructions with writeback that specify Rn as the lowest register in the
reglist are deprecated in ARMv6T2 and above.
In addition, the PUSH and POP instructions are subsets of the STM and LDM instructions and can
therefore be expressed using the STM and LDM instructions. Some forms of PUSH and POP are also
16-bit instructions.
Note
This 16-bit instruction is not available in ThumbEE.
Example
STMDB r1!,{r3-r6,r11,r12}
Incorrect example
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.74 POP on page 10-429.
10.8 Condition codes on page 10-317.
Syntax
STR{type}{cond} Rt, [Rn {, #offset}] ; immediate offset
STR{type}{cond} Rt, [Rn, #offset]! ; pre-indexed
STR{type}{cond} Rt, [Rn], #offset ; post-indexed
STRD{cond} Rt, Rt2, [Rn {, #offset}] ; immediate offset, doubleword
STRD{cond} Rt, Rt2, [Rn, #offset]! ; pre-indexed, doubleword
STRD{cond} Rt, Rt2, [Rn], #offset ; post-indexed, doubleword
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to store.
Rn
is the register on which the memory address is based.
offset
is an offset. If offset is omitted, the address is the contents of Rn.
Rt2
is the additional register to store for doubleword operations.
Not all options are available in every instruction set and architecture.
Table 10-15 Offsets and architectures, STR, word, halfword, and byte
Table 10-15 Offsets and architectures, STR, word, halfword, and byte (continued)
Register restrictions
Rn must be different from Rt in the pre-index and post-index forms.
Use of PC
In ARM instructions you can use PC for Rt in STR word instructions and PC for Rn in STR
instructions with immediate offset syntax (that is the forms that do not writeback to the Rn).
However, this is deprecated in ARMv6T2 and above.
Other uses of PC are not permitted in these ARM instructions.
In Thumb code, using PC in STR instructions is not permitted.
ah Entries in the Architecture column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
EE
ThumbEE variants of the ARM architecture.
ai Rt and Rn must be in the range R0-R7.
aj Must be divisible by 4.
ak Must be divisible by 2.
al Rt must be in the range R0-R7.
Use of SP
You can use SP for Rn.
In ARM code, you can use SP for Rt in word instructions. You can use SP for Rt in non-word
instructions in ARM code but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in word instructions only. All other use of SP for Rt in this
instruction is not permitted in Thumb code.
Example
Related references
10.8 Condition codes on page 10-317.
Syntax
STR{type}{cond} Rt, [Rn, ±Rm {, shift}] ; register offset
STR{type}{cond} Rt, [Rn, ±Rm {, shift}]! ; pre-indexed ; ARM only
STR{type}{cond} Rt, [Rn], ±Rm {, shift} ; post-indexed ; ARM only
STRD{cond} Rt, Rt2, [Rn, ±Rm] ; register offset, doubleword ; ARM only
STRD{cond} Rt, Rt2, [Rn, ±Rm]! ; pre-indexed, doubleword ; ARM only
STRD{cond} Rt, Rt2, [Rn], ±Rm ; post-indexed, doubleword ; ARM only
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to store.
Rn
is the register on which the memory address is based.
Rm
is a register containing a value to be used as the offset. –Rm is not permitted in Thumb
code.
shift
is an optional shift.
Rt2
is the additional register to store for doubleword operations.
Not all options are available in every instruction set and architecture.
Register restrictions
In the pre-index and post-index forms:
• Rn must be different from Rt.
• Rn must be different from Rm in architectures before ARMv6.
Use of PC
In ARM instructions you can use PC for Rt in STR word instructions, and you can use PC for Rn
in STR instructions with register offset syntax (that is, the forms that do not writeback to the Rn).
However, this is deprecated in ARMv6T2 and above.
Other uses of PC are not permitted in ARM instructions.
am Where +/–Rm is shown, you can use –Rm, +Rm, or Rm. Where +Rm is shown, you cannot use –Rm.
an Entries in the Architecture column indicate that the instructions are available as follows:
All
All versions of the ARM architecture.
5E
The ARMv5TE, ARMv6*, and ARMv7 architectures.
T2
The ARMv6T2 and above architectures.
T
The ARMv4T, ARMv5T*, ARMv6*, and ARMv7 architectures.
EE
ThumbEE variants of the ARM architecture.
ao Rt, Rn, and Rm must all be in the range R0-R7.
Use of SP
You can use SP for Rn.
In ARM code, you can use SP for Rt in word instructions. You can use SP for Rt in non-word
ARM instructions but this is deprecated in ARMv6T2 and above.
You can use SP for Rm in ARM instructions but this is deprecated in ARMv6T2 and above.
In Thumb code, you can use SP for Rt in word instructions only. All other use of SP for Rt in this
instruction is not permitted in Thumb code.
Use of SP for Rm is not permitted in Thumb state.
Related references
10.8 Condition codes on page 10-317.
Syntax
STR{type}T{cond} Rt, [Rn {, #offset}] ; immediate offset (Thumb, 32-bit
encoding only)
STR{type}T{cond} Rt, [Rn] {, #offset} ; post-indexed (ARM only)
STR{type}T{cond} Rt, [Rn], ±Rm {, shift} ; post-indexed (register) (ARM
only)
where:
type
can be any one of:
B
unsigned Byte (Zero extend to 32 bits on loads.)
SB
signed Byte (LDR only. Sign extend to 32 bits.)
H
unsigned Halfword (Zero extend to 32 bits on loads.)
SH
signed Halfword (LDR only. Sign extend to 32 bits.)
-
omitted, for Word.
cond
is an optional condition code.
Rt
is the register to load or store.
Rn
is the register on which the memory address is based.
offset
is an offset. If offset is omitted, the address is the value in Rn.
Rm
is a register containing a value to be used as the offset. Rm must not be PC.
shift
is an optional shift.
Operation
When these instructions are executed by privileged software, they access memory with the same
restrictions as they would have if they were executed by unprivileged software.
When executed by unprivileged software, these instructions behave in exactly the same way as the
corresponding store instruction, for example STRSBT behaves in the same way as STRSB.
Related references
10.8 Condition codes on page 10-317.
10.138 STREX
Store Register Exclusive.
Syntax
STREX{cond} Rd, Rt, [Rn {, #offset}]
STREXB{cond} Rd, Rt, [Rn]
STREXH{cond} Rd, Rt, [Rn]
STREXD{cond} Rd, Rt, Rt2, [Rn]
where:
cond
is an optional condition code.
Rd
is the destination register for the returned status.
Rt
is the register to store.
Rt2
is the second register for doubleword stores.
Rn
is the register on which the memory address is based.
offset
is an optional offset applied to the value in Rn. offset is permitted only in Thumb
instructions. If offset is omitted, an offset of 0 is assumed.
Operation
STREX performs a conditional store to memory. The conditions are as follows:
• If the physical address does not have the Shared TLB attribute, and the executing processor
has an outstanding tagged physical address, the store takes place, the tag is cleared, and the
value 0 is returned in Rd.
• If the physical address does not have the Shared TLB attribute, and the executing processor
does not have an outstanding tagged physical address, the store does not take place, and the
value 1 is returned in Rd.
• If the physical address has the Shared TLB attribute, and the physical address is tagged as
exclusive access for the executing processor, the store takes place, the tag is cleared, and the
value 0 is returned in Rd.
• If the physical address has the Shared TLB attribute, and the physical address is not tagged as
exclusive access for the executing processor, the store does not take place, and the value 1 is
returned in Rd.
Restrictions
PC must not be used for any of Rd, Rt, Rt2, or Rn.
For STREX, Rd must not be the same register as Rt, Rt2, or Rn.
For ARM instructions:
• SP can be used but use of SP for any of Rd, Rt, or Rt2 is deprecated in ARMv6T2 and above.
• For STREXD, Rt must be an even numbered register, and not LR.
• Rt2 must be R(t+1).
• offset is not permitted.
Usage
Use LDREX and STREX to implement interprocess communication in multiple-processor and
shared-memory systems.
For reasons of performance, keep the number of instructions between corresponding LDREX and
STREX instructions to a minimum.
Note
The address used in a STREX instruction must be the same as the address in the most recently
executed LDREX instruction.
Architectures
ARM STREX is available in ARMv6 and above.
ARM STREXB, STREXD, and STREXH are available in ARMv6K and above.
All these 32-bit Thumb instructions are available in ARMv6T2 and above, except that STREXD is
not available in the ARMv7-M architecture.
There are no 16-bit versions of these instructions.
Examples
Related references
10.8 Condition codes on page 10-317.
10.139 SUB
Subtract without carry.
Syntax
SUB{S}{cond} {Rd}, Rn, Operand2
SUB{cond} {Rd}, Rn, #imm12 ; Thumb, 32-bit encoding only
where:
S
is an optional suffix. If S is specified, the condition flags are updated on the result of the
operation.
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Operand2
is a flexible second operand.
imm12
is any value in the range 0-4095.
Operation
The SUB instruction subtracts the value of Operand2 or imm12 from the value in Rn.
In certain circumstances, the assembler can substitute one instruction for another. Be aware of this
when reading disassembly listings.
You can use SP in SUB (register) if Rn is SP and shift is omitted or LSL #1, LSL #2, or LSL
#3.
Other uses of SP in ARM SUB instructions are deprecated.
Note
The deprecation of SP and PC in ARM instructions is only in ARMv6T2 and above.
Condition flags
If S is specified, the SUB instruction updates the N, Z, C and V flags according to the result.
16-bit instructions
The following forms of this instruction are available in Thumb code, and are 16-bit instructions:
SUBS Rd, Rn, Rm
Rd, Rn and Rm must all be Lo registers. This form can only be used outside an IT block.
SUB{cond} Rd, Rn, Rm
Rd, Rn and Rm must all be Lo registers. This form can only be used inside an IT block.
SUBS Rd, Rn, #imm
imm range 0-7. Rd and Rn must both be Lo registers. This form can only be used outside
an IT block.
SUB{cond} Rd, Rn, #imm
imm range 0-7. Rd and Rn must both be Lo registers. This form can only be used inside an
IT block.
SUBS Rd, Rd, #imm
imm range 0-255. Rd must be a Lo register. This form can only be used outside an IT
block.
SUB{cond} Rd, Rd, #imm
imm range 0-255. Rd must be a Lo register. This form can only be used inside an IT
block.
SUB{cond} SP, SP, #imm
imm range 0-508, word aligned.
Example
SUBS r8, r6, #240 ; sets the flags based on the result
For clarity, the above examples use consecutive registers for multiword values. There is no
requirement to do this. The following, for example, is perfectly valid:
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.140 SUBS pc, lr on page 10-522.
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
Syntax
SUBS{cond} pc, lr, #imm ; ARM and Thumb code
MOVS{cond} pc, lr ; ARM and Thumb code
op1S{cond} pc, Rn, #imm ; ARM code only and is deprecated
op1S{cond} pc, Rn, Rm {, shift} ; ARM code only and is deprecated
op2S{cond} pc, #imm ; ARM code only and is deprecated
op2S{cond} pc, Rm {, shift} ; ARM code only and is deprecated
where:
op1
is one of ADC, ADD, AND, BIC, EOR, ORN, ORR, RSB, RSC, SBC, and SUB.
op2
is one of MOV and MVN.
cond
is an optional condition code.
imm
is an immediate value. In Thumb code, it is limited to the range 0-255. In ARM code, it is
a flexible second operand.
Rn
is the first operand register. ARM deprecates the use of any register except LR.
Rm
is the optionally shifted second or only operand register.
shift
is an optional condition code.
Usage
SUBS pc, lr, #imm subtracts a value from the link register and loads the PC with the result,
then copies the SPSR to the CPSR.
You can use SUBS pc, lr, #imm to return from an exception if there is no return state on the
stack. The value of #imm depends on the exception to return from.
Notes
SUBS pc, lr, #imm writes an address to the PC. The alignment of this address must be correct
for the instruction set in use after the exception return:
• For a return to ARM, the address written to the PC must be word-aligned.
• For a return to Thumb, the address written to the PC must be halfword-aligned.
• For a return to Jazelle, there are no alignment restrictions on the address written to the PC.
No special precautions are required in software to follow these rules, if you use the instruction to
return after a valid exception entry mechanism.
In Thumb, only SUBS{cond} pc, lr, #imm is a valid instruction. MOVS pc, lr is a
synonym of SUBS pc, lr, #0. Other instructions are undefined.
In ARM, only SUBS{cond} pc, lr, #imm and MOVS{cond} pc, lr are valid instructions.
Other instructions are deprecated in ARMv6T2 and above.
Caution
Do not use these instructions in User mode or System mode. The assembler cannot warn you
about this.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above, except the ARMv7-M
architecture.
There is no 16-bit version of this instruction in Thumb.
Related references
10.14 AND on page 10-329.
10.56 MOV on page 10-402.
10.3 Flexible second operand (Operand2) on page 10-310.
10.10 ADD on page 10-320.
10.8 Condition codes on page 10-317.
10.141 SVC
SuperVisor Call.
Syntax
SVC{cond} #imm
where:
cond
is an optional condition code.
imm
is an expression evaluating to an integer in the range:
• 0 to 224–1 (a 24-bit value) in an ARM instruction.
• 0-255 (an 8-bit value) in a Thumb instruction.
Operation
The SVC instruction causes an exception. This means that the processor mode changes to
Supervisor, the CPSR is saved to the Supervisor mode SPSR, and execution branches to the SVC
vector.
imm is ignored by the processor. However, it can be retrieved by the exception handler to
determine what service is being requested.
Note
SVC was called SWI in earlier versions of the ARM assembly language. SWI instructions
disassemble to SVC, with a comment to say that this was formerly SWI.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 16-bit Thumb instruction is available in all T variants of the ARM architecture.
There is no 32-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
Related information
Handling Processor Exceptions.
Syntax
SWP{B}{cond} Rt, Rt2, [Rn]
where:
cond
is an optional condition code.
B
is an optional suffix. If B is present, a byte is swapped. Otherwise, a 32-bit word is
swapped.
Rt
is the destination register. Rt must not be PC.
Rt2
is the source register. Rt2 can be the same register as Rt. Rt2 must not be PC.
Rn
contains the address in memory. Rn must be a different register from both Rt and Rt2.
Rn must not be PC.
Usage
You can use SWP and SWPB to implement semaphores:
• Data from memory is loaded into Rt.
• The contents of Rt2 are saved to memory.
• If Rt2 is the same register as Rt, the contents of the register are swapped with the contents of
the memory location.
Note
The use of SWP and SWPB is deprecated in ARMv6 and above. You can use LDREX and STREX
instructions to implement more sophisticated semaphores in ARMv6 and above.
Architectures
These ARM instructions are available in all versions of the ARM architecture.
There are no Thumb SWP or SWPB instructions.
Related references
10.47 LDREX on page 10-389.
10.8 Condition codes on page 10-317.
10.143 SXTAB
Sign extend Byte with Add, to extend an 8-bit value to a 32-bit value.
Syntax
SXTAB{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
This instruction does the following:
1. Rotate the value from Rm right by 0, 8, 16 or 24 bits.
2. Extract bits[7:0] from the value obtained.
3. Sign extend to 32 bits.
4. Add the value from Rn.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.144 SXTAB16
Sign extend two Bytes with Add, to extend two 8-bit values to two 16-bit values.
Syntax
SXTAB16{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
This instruction does the following:
1. Rotate the value from Rm right by 0, 8, 16 or 24 bits.
2. Extract bits[23:16] and bits[7:0] from the value obtained.
3. Sign extend to 16 bits.
4. Add them to bits[31:16] and bits[15:0] respectively of Rn to form bits[31:16] and bits[15:0] of
the result.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.145 SXTAH
Sign extend Halfword with Add, to extend a 16-bit value to a 32-bit value.
Syntax
SXTAH{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
This instruction does the following:
1. Rotate the value from Rm right by 0, 8, 16 or 24 bits.
2. Extract bits[15:0] from the value obtained.
3. Sign extend to 32 bits.
4. Add the value from Rn.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.146 SXTB
Sign extend Byte, to extend an 8-bit value to a 32-bit value.
Syntax
SXTB{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
This instruction does the following:
1. Rotates the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracts bits[7:0] from the value obtained.
3. Sign extends to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
SXTB Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
This 16-bit Thumb instruction is available in ARMv6 and above.
Related references
10.8 Condition codes on page 10-317.
10.147 SXTB16
Sign extend two bytes.
Syntax
SXTB16{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
SXTB16 extends two 8-bit values to two 16-bit values. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[23:16] and bits[7:0] from the value obtained.
3. Sign extending to 16 bits each.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.148 SXTH
Sign extend Halfword.
Syntax
SXTH{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
SXTH extends a 16-bit value to a 32-bit value. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[15:0] from the value obtained.
3. Sign extending to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
SXTH Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
This 16-bit Thumb instruction is available in ARMv6 and above.
Example
Incorrect example
SXTH r9, r3, r2, ROR #12 ; rotation must be by 0, 8, 16, or 24.
Related references
10.8 Condition codes on page 10-317.
10.149 SYS
Execute system coprocessor instruction.
Syntax
SYS{cond} instruction{, Rn}
where:
cond
is an optional condition code.
instruction
is the coprocessor instruction to execute.
Rn
is an operand to the instruction. For instructions that take an argument, Rn is compulsory.
For instructions that do not take an argument, Rn is optional and if it is not specified, R0
is used. Rn must not be PC.
Usage
You can use this instruction to execute special coprocessor instructions such as cache, branch
predictor, and TLB operations. The instructions operate by writing to special write-only
coprocessor registers. The instruction names are the same as the write-only coprocessor register
names and are listed in the ARMv7-AR Architecture Reference Manual. For example:
Architectures
The SYS ARM instruction is available in ARMv7-A and ARMv7-R.
The SYS 32-bit Thumb instruction is available in ARMv7-A and ARMv7-R.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
Syntax
TBB [Rn, Rm]
TBH [Rn, Rm, LSL #1]
where:
Rn
is the base register. This contains the address of the table of branch lengths. Rn must not
be SP.
If PC is specified for Rn, the value used is the address of the instruction plus 4.
Rm
is the index register. This contains an index into the table.
Rm must not be PC or SP.
Operation
These instructions cause a PC-relative forward branch using a table of single byte offsets (TBB) or
halfword offsets (TBH). Rn provides a pointer to the table, and Rm supplies an index into the table.
The branch length is twice the value of the byte (TBB) or the halfword (TBH) returned from the
table. The target of the branch table must be in the same execution state.
Notes
In ThumbEE, if the value in the base register is zero, execution branches to the NullCheck handler
at HandlerBase - 4.
Architectures
These 32-bit Thumb instructions are available in ARMv6T2 and above.
There are no versions of these instructions in ARM or in 16-bit Thumb encodings.
10.151 TEQ
Test Equivalence.
Syntax
TEQ{cond} Rn, Operand2
where:
cond
is an optional condition code.
Rn
is the ARM register holding the first operand.
Operand2
is a flexible second operand.
Usage
This instruction tests the value in a register against Operand2. It updates the condition flags on
the result, but does not place the result in any register.
The TEQ instruction performs a bitwise Exclusive OR operation on the value in Rn and the value
of Operand2. This is the same as an EORS instruction, except that the result is discarded.
Use the TEQ instruction to test if two values are equal, without affecting the V or C flags (as CMP
does).
TEQ is also useful for testing the sign of a value. After the comparison, the N flag is the logical
Exclusive OR of the sign bits of the two operands.
Register restrictions
In this Thumb instruction, you cannot use SP or PC for Rn or Operand2.
In this ARM instruction, use of SP or PC is deprecated in ARMv6T2 and above.
For ARM instructions:
• If you use PC (R15) as Rn, the value used is the address of the instruction plus 8.
• You cannot use PC for any operand in any data processing instruction that has a register-
controlled shift.
Condition flags
This instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
Architectures
This ARM instruction is available in all architectures that support the ARM instruction set.
The TEQ Thumb instruction is available in ARMv6T2 and above.
Example
TEQEQ r10, r9
Incorrect example
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
10.152 TST
Test bits.
Syntax
TST{cond} Rn, Operand2
where:
cond
is an optional condition code.
Rn
is the ARM register holding the first operand.
Operand2
is a flexible second operand.
Operation
This instruction tests the value in a register against Operand2. It updates the condition flags on
the result, but does not place the result in any register.
The TST instruction performs a bitwise AND operation on the value in Rn and the value of
Operand2. This is the same as an ANDS instruction, except that the result is discarded.
Register restrictions
In this Thumb instruction, you cannot use SP or PC for Rn or Operand2.
In this ARM instruction, use of SP or PC is deprecated in ARMv6T2 and above.
For ARM instructions:
• If you use PC (R15) as Rn, the value used is the address of the instruction plus 8.
• You cannot use PC for any operand in any data processing instruction that has a register-
controlled shift.
Condition flags
This instruction:
• Updates the N and Z flags according to the result.
• Can update the C flag during the calculation of Operand2.
• Does not affect the V flag.
16-bit instructions
The following form of the TST instruction is available in Thumb code, and is a 16-bit instruction:
TST Rn, Rm
Rn and Rm must both be Lo registers.
Architectures
This ARM instruction is available in all architectures that support the ARM instruction set.
The TST Thumb instruction is available in all architectures that support the Thumb instruction set.
Examples
Related references
10.3 Flexible second operand (Operand2) on page 10-310.
10.8 Condition codes on page 10-317.
10.153 UADD8
Unsigned parallel byte-wise addition.
Syntax
UADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four unsigned integer additions on the corresponding bytes of the
operands and writes the results into the corresponding bytes of the destination. The results are
modulo 28. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[0]
for bits[7:0] of the result.
GE[1]
for bits[15:8] of the result.
GE[2]
for bits[23:16] of the result.
GE[3]
for bits[31:24] of the result.
It sets a GE flag to 1 to indicate that the corresponding result overflowed, generating a carry. This
is equivalent to an ADDS instruction setting the C condition flag to 1.
You can use these flags to control a following SEL instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.154 UADD16
Unsigned parallel halfword-wise addition.
Syntax
UADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two unsigned integer additions on the corresponding halfwords of the
operands and writes the results into the corresponding halfwords of the destination. The results are
modulo 216. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result overflowed, generating a
carry. This is equivalent to an ADDS instruction setting the C condition flag to 1.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.155 UASX
Unsigned parallel add and subtract halfwords with exchange.
Syntax
UASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It writes the
results into the corresponding halfwords of the destination. The results are modulo 216. It sets the
APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets GE[1:0] to 1 to indicate that the subtraction gave a result greater than or equal to zero,
meaning a borrow did not occur. This is equivalent to a SUBS instruction setting the C condition
flag to 1.
It sets GE[3:2] to 1 to indicate that the addition overflowed, generating a carry. This is equivalent
to an ADDS instruction setting the C condition flag to 1.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.156 UBFX
Unsigned Bit Field Extract.
Syntax
UBFX{cond} Rd, Rn, #lsb, #width
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the source register.
lsb
is the bit number of the least significant bit in the bitfield, in the range 0 to 31.
width
is the width of the bitfield, in the range 1 to (32–lsb).
Operation
Copies adjacent bits from one register into the least significant bits of a second register, and zero
extends to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in the ARM instruction but this is deprecated in ARMv6T2 and above. You
cannot use SP in the Thumb instruction.
Condition flags
This instruction does not alter any flags.
Architectures
This ARM instruction is available in ARMv6T2 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.157 UDIV
Unsigned Divide.
Syntax
UDIV{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the value to be divided.
Rm
is a register holding the divisor.
Register restrictions
PC or SP cannot be used for Rd, Rn, or Rm.
Architectures
This 32-bit Thumb instruction is available in ARMv7-R and ARMv7-M only.
There are no ARM or 16-bit Thumb encodings of UDIV.
Related references
10.8 Condition codes on page 10-317.
10.158 UHADD8
Unsigned halving parallel byte-wise addition.
Syntax
UHADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four unsigned integer additions on the corresponding bytes of the
operands, halves the results, and writes the results into the corresponding bytes of the destination.
This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.159 UHADD16
Unsigned halving parallel halfword-wise addition.
Syntax
UHADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two unsigned integer additions on the corresponding halfwords of the
operands, halves the results, and writes the results into the corresponding halfwords of the
destination. This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.160 UHASX
Unsigned halving parallel add and subtract halfwords with exchange.
Syntax
UHASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It halves the
results and writes them into the corresponding halfwords of the destination. This cannot cause
overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.161 UHSAX
Unsigned halving parallel subtract and add halfwords with exchange.
Syntax
UHSAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It halves
the results and writes them into the corresponding halfwords of the destination. This cannot cause
overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.162 UHSUB8
Unsigned halving parallel byte-wise subtraction.
Syntax
UHSUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand, halves the results, and writes the results into the corresponding bytes of the destination.
This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.163 UHSUB16
Unsigned halving parallel halfword-wise subtraction.
Syntax
UHSUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand, halves the results, and writes the results into the corresponding halfwords of
the destination. This cannot cause overflow.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.164 UMAAL
Unsigned Multiply Accumulate Accumulate Long.
Syntax
UMAAL{cond} RdLo, RdHi, Rn, Rm
where:
cond
is an optional condition code.
RdLo, RdHi
are the destination registers for the 64-bit result. They also hold the two 32-bit
accumulate operands. RdLo and RdHi must be different registers.
Rn, Rm
are the registers holding the multiply operands.
Operation
The UMAAL instruction multiplies the 32-bit values in Rn and Rm, adds the two 32-bit values in
RdHi and RdLo, and stores the 64-bit result to RdLo, RdHi.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Related references
10.8 Condition codes on page 10-317.
10.165 UMLAL
Unsigned Long Multiply, with optional Accumulate, with 32-bit operands and 64-bit result and
accumulator.
Syntax
UMLAL{S}{cond} RdLo, RdHi, Rn, Rm
where:
S
is an optional suffix available in ARM state only. If S is specified, the condition flags are
updated based on the result of the operation.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers. They also hold the accumulating value. RdLo and RdHi must
be different registers.
Rn, Rm
are ARM registers holding the operands.
Operation
The UMLAL instruction interprets the values from Rn and Rm as unsigned integers. It multiplies
these integers, and adds the 64-bit result to the 64-bit unsigned integer contained in RdHi and
RdLo.
Register restrictions
Rn must be different from RdLo and RdHi in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, this instruction:
• Updates the N and Z flags according to the result.
• Does not affect the C or V flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.166 UMULL
Unsigned Long Multiply, with 32-bit operands, and 64-bit result.
Syntax
UMULL{S}{cond} RdLo, RdHi, Rn, Rm
where:
S
is an optional suffix available in ARM state only. If S is specified, the condition flags are
updated based on the result of the operation.
cond
is an optional condition code.
RdLo, RdHi
are the destination registers. RdLo and RdHi must be different registers.
Rn, Rm
are ARM registers holding the operands.
Operation
The UMULL instruction interprets the values from Rn and Rm as unsigned integers. It multiplies
these integers and places the least significant 32 bits of the result in RdLo, and the most significant
32 bits of the result in RdHi.
Register restrictions
Rn must be different from RdLo and RdHi in architectures before ARMv6.
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
If S is specified, this instruction:
• Updates the N and Z flags according to the result.
• Does not affect the C or V flags.
Architectures
This ARM instruction is available in all versions of the ARM architecture.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
Syntax
UND{cond}{.W} {#expr}
where:
cond
is an optional condition code.
.W
is an optional instruction width specifier.
expr
evaluates to a numeric value. The following table shows the range and encoding of expr
in the instruction, where Y shows the locations of the bits that encode for expr and V is
the 4 bits that encode for the condition code.
If expr is omitted, the value 0 is used.
Usage
An attempt to execute an undefined instruction causes the Undefined instruction exception.
Architecturally undefined instructions are expected to remain undefined.
Disassembly
The encodings that this pseudo-instruction produces disassemble to DCI.
Related references
10.8 Condition codes on page 10-317.
10.168 UQADD8
Unsigned saturating parallel byte-wise addition.
Syntax
UQADD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs four unsigned integer additions on the corresponding bytes of the
operands and writes the results into the corresponding bytes of the destination. It saturates the
results to the unsigned range 0 ≤ x ≤ 28 –1. The Q flag is not affected even if this operation
saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.169 UQADD16
Unsigned saturating parallel halfword-wise addition.
Syntax
UQADD16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction performs two unsigned integer additions on the corresponding halfwords of the
operands and writes the results into the corresponding halfwords of the destination. It saturates the
results to the unsigned range 0 ≤ x ≤ 216 –1. The Q flag is not affected even if this operation
saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.170 UQASX
Unsigned saturating parallel add and subtract halfwords with exchange.
Syntax
UQASX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs an addition on
the two top halfwords of the operands and a subtraction on the bottom two halfwords. It writes the
results into the corresponding halfwords of the destination. It saturates the results to the unsigned
range 0 ≤ x ≤ 216 –1. The Q flag is not affected even if this operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.171 UQSAX
Unsigned saturating parallel subtract and add halfwords with exchange.
Syntax
UQSAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It writes
the results into the corresponding halfwords of the destination. It saturates the results to the
unsigned range 0 ≤ x ≤ 216 –1. The Q flag is not affected even if this operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.172 UQSUB8
Unsigned saturating parallel byte-wise subtraction.
Syntax
UQSUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand and writes the results into the corresponding bytes of the destination. It saturates the
results to the unsigned range 0 ≤ x ≤ 28 –1. The Q flag is not affected even if this operation
saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.173 UQSUB16
Unsigned saturating parallel halfword-wise subtraction.
Syntax
UQSUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand and writes the results into the corresponding halfwords of the destination. It
saturates the results to the unsigned range 0 ≤ x ≤ 216 –1. The Q flag is not affected even if this
operation saturates.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, Q, or GE flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.174 USAD8
Unsigned Sum of Absolute Differences.
Syntax
USAD8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Rm
is the register holding the second operand.
Operation
The USAD8 instruction finds the four differences between the unsigned values in corresponding
bytes of Rn and Rm. It adds the absolute values of the four differences, and saves the result to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not alter any flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.175 USADA8
Unsigned Sum of Absolute Differences and Accumulate.
Syntax
USADA8{cond} Rd, Rn, Rm, Ra
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the first operand.
Rm
is the register holding the second operand.
Ra
is the register holding the accumulate operand.
Operation
The USADA8 instruction adds the absolute values of the four differences to the value in Ra, and
saves the result to Rd.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not alter any flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Examples
Incorrect examples
Related references
10.8 Condition codes on page 10-317.
10.176 USAT
Unsigned Saturate to any bit position, with optional shift before saturating.
Syntax
USAT{cond} Rd, #sat, Rm{, shift}
where:
cond
is an optional condition code.
Rd
is the destination register.
sat
specifies the bit position to saturate to, in the range 0 to 31.
Rm
is the register containing the operand.
shift
is an optional shift. It must be one of the following:
ASR #n
where n is in the range 1-32 (ARM) or 1-31 (Thumb).
LSL #n
where n is in the range 0-31.
Operation
The USAT instruction applies the specified shift to a signed value, then saturates to the unsigned
range 0 ≤ x ≤ 2sat – 1.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs, this instruction sets the Q flag. To read the state of the Q flag, use an MRS
instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.129 SSAT16 on page 10-498.
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.177 USAT16
Parallel halfword Saturate.
Syntax
USAT16{cond} Rd, #sat, Rn
where:
cond
is an optional condition code.
Rd
is the destination register.
sat
specifies the bit position to saturate to, in the range 0 to 15.
Rn
is the register holding the operand.
Operation
Halfword-wise unsigned saturation to any bit position.
The USAT16 instruction saturates each signed halfword to the unsigned range 0 ≤ x ≤ 2sat –1.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Q flag
If saturation occurs on either halfword, this instruction sets the Q flag. To read the state of the Q
flag, use an MRS instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.62 MRS (PSR to general-purpose register) on page 10-409.
10.8 Condition codes on page 10-317.
10.178 USAX
Unsigned parallel subtract and add halfwords with exchange.
Syntax
USAX{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction exchanges the two halfwords of the second operand, then performs a subtraction
on the two top halfwords of the operands and an addition on the bottom two halfwords. It writes
the results into the corresponding halfwords of the destination. The results are modulo 216. It sets
the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets GE[1:0] to 1 to indicate that the addition overflowed, generating a carry. This is equivalent
to an ADDS instruction setting the C condition flag to 1.
It sets GE[3:2] to 1 to indicate that the subtraction gave a result greater than or equal to zero,
meaning a borrow did not occur. This is equivalent to a SUBS instruction setting the C condition
flag to 1.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.179 USUB8
Unsigned parallel byte-wise subtraction.
Syntax
USUB8{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each byte of the second operand from the corresponding byte of the first
operand and writes the results into the corresponding bytes of the destination. The results are
modulo 28. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
GE flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[0]
for bits[7:0] of the result.
GE[1]
for bits[15:8] of the result.
GE[2]
for bits[23:16] of the result.
GE[3]
for bits[31:24] of the result.
It sets a GE flag to 1 to indicate that the corresponding result is greater than or equal to zero,
meaning a borrow did not occur. This is equivalent to a SUBS instruction setting the C condition
flag to 1.
You can use these flags to control a following SEL instruction.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.180 USUB16
Unsigned parallel halfword-wise subtraction.
Syntax
USUB16{cond} {Rd}, Rn, Rm
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm, Rn
are the ARM registers holding the operands.
Operation
This instruction subtracts each halfword of the second operand from the corresponding halfword
of the first operand and writes the results into the corresponding halfwords of the destination. The
results are modulo 216. It sets the APSR GE flags.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not affect the N, Z, C, V, or Q flags.
It sets the GE flags in the APSR as follows:
GE[1:0]
for bits[15:0] of the result.
GE[3:2]
for bits[31:16] of the result.
It sets a pair of GE flags to 1 to indicate that the corresponding result is greater than or equal to
zero, meaning a borrow did not occur. This is equivalent to a SUBS instruction setting the C
condition flag to 1.
You can use these flags to control a following SEL instruction.
Note
GE[1:0] are set or cleared together, and GE[3:2] are set or cleared together.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.101 SEL on page 10-466.
10.8 Condition codes on page 10-317.
10.181 UXTAB
Zero extend Byte and Add.
Syntax
UXTAB{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTAB extends an 8-bit value to a 32-bit value. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[7:0] from the value obtained.
3. Zero extending to 32 bits.
4. Adding the value from Rn.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it are only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.182 UXTAB16
Zero extend two Bytes and Add.
Syntax
UXTAB16{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTAB16 extends two 8-bit values to two 16-bit values. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[23:16] and bits[7:0] from the value obtained.
3. Zero extending them to 16 bits.
4. Adding them to bits[31:16] and bits[15:0] respectively of Rn to form bits[31:16] and bits[15:0]
of the result.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Example
Related references
10.8 Condition codes on page 10-317.
10.183 UXTAH
Zero extend Halfword and Add.
Syntax
UXTAH{cond} {Rd}, Rn, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rn
is the register holding the number to add.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTAH extends a 16-bit value to a 32-bit value. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[15:0] from the value obtained.
3. Zero extending to 32 bits.
4. Adding the value from Rn.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.184 UXTB
Zero extend Byte.
Syntax
UXTB{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTB extends an 8-bit value to a 32-bit value. It does this by:
1. Rotating the value from Rm right by 0, 8, 16, or 24 bits.
2. Extracting bits[7:0] from the value obtained.
3. Zero extending to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instruction
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
UXTB Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
This 16-bit Thumb instruction is available in ARMv6 and above.
Related references
10.8 Condition codes on page 10-317.
10.185 UXTB16
Zero extend two Bytes.
Syntax
UXTB16{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTB16 extends two 8-bit values to two 16-bit values. It does this by:
1. Rotating the value from Rm right by 0, 8, 16 or 24 bits.
2. Extracting bits[23:16] and bits[7:0] from the value obtained.
3. Zero extending each to 16 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
There is no 16-bit version of this instruction in Thumb.
Related references
10.8 Condition codes on page 10-317.
10.186 UXTH
Zero extend Halfword.
Syntax
UXTH{cond} {Rd}, Rm {,rotation}
where:
cond
is an optional condition code.
Rd
is the destination register.
Rm
is the register holding the value to extend.
rotation
is one of:
ROR #8
Value from Rm is rotated right 8 bits.
ROR #16
Value from Rm is rotated right 16 bits.
ROR #24
Value from Rm is rotated right 24 bits.
If rotation is omitted, no rotation is performed.
Operation
UXTH extends a 16-bit value to a 32-bit value. It does this by:
1. Rotating the value from Rm right by 0, 8, 16, or 24 bits.
2. Extracting bits[15:0] from the value obtained.
3. Zero extending to 32 bits.
Register restrictions
You cannot use PC for any register.
You can use SP in ARM instructions but this is deprecated in ARMv6T2 and above. You cannot
use SP in Thumb instructions.
Condition flags
This instruction does not change the flags.
16-bit instructions
The following form of this instruction is available in Thumb code, and is a 16-bit instruction:
UXTH Rd, Rm
Rd and Rm must both be Lo registers.
Architectures
This ARM instruction is available in ARMv6 and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above. For the ARMv7-M
architecture, it is only available in an ARMv7E-M implementation.
This 16-bit Thumb instruction is available in ARMv6 and above.
Related references
10.8 Condition codes on page 10-317.
10.187 WFE
Wait For Event.
Syntax
WFE{cond}
where:
cond
is an optional condition code.
Operation
This is a hint instruction. It is optional whether this instruction is implemented or not. If this
instruction is not implemented, it executes as a NOP. The assembler produces a diagnostic message
if the instruction executes as a NOP on the target.
WFE executes as a NOP instruction in ARMv6T2.
If the Event Register is not set, WFE suspends execution until one of the following events occurs:
• An IRQ interrupt, unless masked by the CPSR I-bit.
• An FIQ interrupt, unless masked by the CPSR F-bit.
• An Imprecise Data abort, unless masked by the CPSR A-bit.
• A Debug Entry request, if Debug is enabled.
• An Event signaled by another processor using the SEV instruction.
If the Event Register is set, WFE clears it and returns immediately.
If WFE is implemented, SEV must also be implemented.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6T2 and above.
Related references
10.69 NOP on page 10-420.
10.8 Condition codes on page 10-317.
10.188 WFI
Wait for Interrupt.
Syntax
WFI{cond}
where:
cond
is an optional condition code.
Operation
This is a hint instruction. It is optional whether this instruction is implemented or not. If this
instruction is not implemented, it executes as a NOP. The assembler produces a diagnostic message
if the instruction executes as a NOP on the target.
WFI executes as a NOP instruction in ARMv6T2.
WFI suspends execution until one of the following events occurs:
• An IRQ interrupt, regardless of the CPSR I-bit.
• An FIQ interrupt, regardless of the CPSR F-bit.
• An Imprecise Data abort, unless masked by the CPSR A-bit.
• A Debug Entry request, regardless of whether Debug is enabled.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6T2 and above.
Related references
10.69 NOP on page 10-420.
10.8 Condition codes on page 10-317.
10.189 YIELD
Yield.
Syntax
YIELD{cond}
where:
cond
is an optional condition code.
Operation
This is a hint instruction. It is optional whether this instruction is implemented or not. If this
instruction is not implemented, it executes as a NOP. The assembler produces a diagnostic message
if the instruction executes as a NOP on the target.
YIELD executes as a NOP instruction in ARMv6T2.
YIELD indicates to the hardware that the current thread is performing a task, for example a
spinlock, that can be swapped out. Hardware can use this hint to suspend and resume threads in a
multithreading system.
Architectures
This ARM instruction is available in ARMv6K and above.
This 32-bit Thumb instruction is available in ARMv6T2 and above.
This 16-bit Thumb instruction is available in ARMv6T2 and above.
Related references
10.69 NOP on page 10-420.
10.8 Condition codes on page 10-317.
Note
ARM deprecates the use of ThumbEE instructions.
BLX
You can use the BLX instruction as a branch in ThumbEE code, but you cannot use it to change
instruction set state. You cannot use the BLX{cond} label form of this instruction in
ThumbEE. In the register form, bit[0] of Rm must be 1, and execution continues at the target
address in ThumbEE state.
BX, BXJ
You can use the BX and BXJ instructions as branches in ThumbEE code, but you cannot use them
to change instruction set state. Bit[0] of Rm must be 1, and execution continues at the target
address in ThumbEE state.
ERET
You cannot use ERET in ThumbEE state.
LDM, STM
16-bit versions of a subset of the LDM and STM instructions are available in Thumb code. These
16-bit instructions are not available in ThumbEE.
LDR (register-relative)
The following table shows the possible offsets between the label and the current instruction in
ThumbEE:
RFE, SRS
Do not use these instructions in ThumbEE.
Note
Unless stated otherwise, ThumbEE instructions are identical to Thumb instructions.
Related references
10.1 ARM and Thumb instruction summary on page 10-301.
11.3 CHKA on page 11-589.
11.4 ENTERX and LEAVEX on page 11-590.
11.5 HB, HBL, HBLP, and HBP on page 11-591.
11.3 CHKA
Check Array.
Syntax
CHKA Rn, Rm
where:
Rn
contains the array size. Rn must not be PC.
Rm
contains the array index. Rn must not be PC or SP.
Operation
CHKA compares the unsigned values in two registers.
If the value in the first register is lower than, or the same as, the second, it copies the PC to the
LR, and causes a branch to the IndexCheck handler.
Architectures
This instruction is not available in ARM or Thumb state.
This 16-bit ThumbEE instruction is only available in ARMv7, with ThumbEE support.
Syntax
ENTERX
LEAVEX
Usage
ENTERX causes a change from Thumb state to ThumbEE state, or has no effect in ThumbEE state.
LEAVEX causes a change from ThumbEE state to Thumb state, or has no effect in Thumb state.
Do not use ENTERX or LEAVEX in an IT block.
Architectures
These instructions are not available in the ARM instruction set.
These 32-bit Thumb and ThumbEE instructions are available in ARMv7, with ThumbEE support.
There are no 16-bit versions of these instructions.
Related information
ARM Architecture Reference Manual.
Syntax
HB{L} #HandlerID
HB{L}P #imm, #HandlerID
where:
L
is an optional suffix. If L is present, the instruction saves a return address in the LR.
P
is an optional suffix. If P is present, the instruction passes the value of imm to the handler
in R8.
imm
is an immediate value. If L is present, imm must be in the range 0-31, otherwise imm must
be in the range 0-7.
HandlerID
is the index number of the handler to be called. If P is present, HandlerID must be in the
range 0-31, otherwise HandlerID must be in the range 0-255.
Operation
This instruction can optionally store a return address to the LR, pass a parameter to the handler, or
both.
Architectures
These instructions are not available in ARM or Thumb state.
These 16-bit ThumbEE instructions are only available in ThumbEE state, in ARMv7 with
ThumbEE support.
12.4 Interleaving provided by load and store element and structure instructions
Many instructions in this group provide interleaving when structures are stored to memory, and
de-interleaving when structures are loaded from memory.
The following figure shows an example of de-interleaving. Interleaving is the inverse process.
A[0].x
A[0].y
A[0].z
A[1].x
A[1].y
A[1].z
A[2].x
A[2].y
A[2].z
A[3].x
A[3].y
A[3].z X3 X2 X1 X0 D0
Y3 Y2 Y1 Y0 D1
Z3 Z2 Z1 Z0 D2
Related concepts
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.50 VLDn (single n-element structure to one lane) on page 12-648.
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
12.52 VLDn (multiple n-element structures) on page 12-652.
Related information
ARM Architecture Reference Manual.
12.5 Alignment restrictions in load and store element and structure instructions
Many of these instructions allow you to specify memory alignment restrictions.
When the alignment is not specified in the instruction, the alignment restriction is controlled by
the A bit (SCTLR bit[1]):
• If the A bit is 0, there are no alignment restrictions (except for strongly-ordered or device
memory, where accesses must be element-aligned).
• If the A bit is 1, accesses must be element-aligned.
If an address is not correctly aligned, an alignment fault occurs.
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
Related references
12.50 VLDn (single n-element structure to one lane) on page 12-648.
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
12.52 VLDn (multiple n-element structures) on page 12-652.
Related information
ARM Architecture Reference Manual.
Syntax
VABA{cond}.datatype {Qd}, Qn, Qm
VABA{cond}.datatype {Dd}, Dn, Dm
VABAL{cond}.datatype Qd, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Operation
VABA subtracts the elements of one vector from the corresponding elements of another vector, and
accumulates the absolute values of the results into the elements of the destination vector.
VABAL is the long version of the VABA instruction.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VABD{cond}.datatype {Qd}, Qn, Qm
VABD{cond}.datatype {Dd}, Dn, Dm
VABDL{cond}.datatype Qd, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of:
• S8, S16, S32, U8, U16, or U32 for VABDL.
• S8, S16, S32, U8, U16, U32 or F32 for VABD.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Operation
VABD subtracts the elements of one vector from the corresponding elements of another vector, and
places the absolute values of the results into the elements of the destination vector.
VABDL is the long version of the VABD instruction.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.8 VABS
Vector Absolute
Syntax
VABS{cond}.datatype Qd, Qm
VABS{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VABS takes the absolute value of each element in a vector, and places the results in a second
vector. (The floating-point version only clears the sign bit.)
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.101 VQABS on page 12-702.
10.8 Condition codes on page 10-317.
Syntax
VABS{cond}.F32 Sd, Sm
VABS{cond}.F64 Dd, Dm
where:
cond
is an optional condition code.
Sd, Sm
are the single-precision registers for the result and operand.
Dd, Dm
are the double-precision registers for the result and operand.
Operation
The VABS instruction takes the contents of Sm or Dm, clears the sign bit, and places the result in Sd
or Dd. This gives the absolute value.
If the operand is a NaN, the sign bit is determined as above, but no exception is produced.
Floating-point exceptions
VABS instructions do not produce any exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VACop{cond}.F32 {Qd}, Qn, Qm
VACop{cond}.F32 {Dd}, Dn, Dm
where:
op
must be one of:
GE
Absolute Greater than or Equal.
GT
Absolute Greater Than.
LE
Absolute Less than or Equal.
LT
Absolute Less Than.
cond
is an optional condition code.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
The result datatype is I32.
Operation
These instructions take the absolute value of each element in a vector, and compare it with the
absolute value of the corresponding element of a second vector. If the condition is true, the
corresponding element in the destination vector is set to all ones. Otherwise, it is set to all zeros.
Note
On disassembly, the VACLE and VACLT pseudo-instructions are disassembled to the corresponding
VACGE and VACGT instructions, with the operands reversed.
Related references
10.8 Condition codes on page 10-317.
Syntax
VADD{cond}.F32 {Sd}, Sn, Sm
VADD{cond}.F64 {Dd}, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VADD instruction adds the values in the operand registers and places the result in the
destination register.
Floating-point exceptions
The VADD instruction can produce Invalid Operation, Overflow, or Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
12.12 VADD
Vector Add.
Syntax
VADD{cond}.datatype {Qd}, Qn, Qm
VADD{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, I64, or F32
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VADD adds corresponding elements in two vectors, and places the results in the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.14 VADDL and VADDW on page 12-612.
12.102 VQADD on page 12-703.
10.8 Condition codes on page 10-317.
12.13 VADDHN
Vector Add and Narrow, selecting High half.
Syntax
VADDHN{cond}.datatype Dd, Qn, Qm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector.
Operation
VADDHN adds corresponding elements in two vectors, selects the most significant halves of the
results, and places the final results in the destination vector. Results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.115 VRADDHN on page 12-716.
10.8 Condition codes on page 10-317.
Syntax
VADDL{cond}.datatype Qd, Dn, Dm ; Long operation
VADDW{cond}.datatype {Qd,} Qn, Dm ; Wide operation
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Qd, Qn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
wide operation.
Operation
VADDL adds corresponding elements in two doubleword vectors, and places the results in the
destination quadword vector.
VADDW adds corresponding elements in one quadword and one doubleword vector, and places the
results in the destination quadword vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.12 VADD on page 12-610.
10.8 Condition codes on page 10-317.
Syntax
VAND{cond}.datatype Qd, #imm
VAND{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be either I8, I16, I32, or I64.
Qd or Dd
is the NEON register for the result.
imm
is the immediate value.
Operation
VAND takes each element of the destination vector, performs a bitwise AND with an immediate
value, and returns the result into the destination vector.
Note
On disassembly, this pseudo-instruction is disassembled to a corresponding VBIC instruction, with
the complementary immediate value.
Immediate values
If datatype is I16, the immediate value must have one of the following forms:
• 0xFFXY.
• 0xXYFF.
If datatype is I32, the immediate value must have one of the following forms:
• 0xFFFFFFXY.
• 0xFFFFXYFF.
• 0xFFXYFFFF.
• 0xXYFFFFFF.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.17 VBIC (immediate) on page 12-615.
10.8 Condition codes on page 10-317.
Syntax
VAND{cond}{.datatype} {Qd}, Qn, Qm
VAND{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional data type. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VAND performs a bitwise logical AND between two registers, and places the result in the
destination register.
Related references
10.8 Condition codes on page 10-317.
Syntax
VBIC{cond}.datatype Qd, #imm
VBIC{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be either I8, I16, I32, or I64.
Qd or Dd
is the NEON register for the source and result.
imm
is the immediate value.
Operation
VBIC takes each element of the destination vector, performs a bitwise AND complement with an
immediate value, and returns the result in the destination vector.
Immediate values
You can either specify imm as a pattern which the assembler repeats to fill the destination register,
or you can directly specify the immediate value (that conforms to the pattern) in full. The pattern
for imm depends on datatype as shown in the following table:
I16 I32
0x00XY 0x000000XY
0xXY00 0x0000XY00
0x00XY0000
0xXY000000
If you use the I8 or I64 datatypes, the assembler converts it to either the I16 or I32 instruction
to match the pattern of imm. If the immediate value does not match any of the patterns in the
preceding table, the assembler generates an error.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.15 VAND (immediate) on page 12-613.
10.8 Condition codes on page 10-317.
Syntax
VBIC{cond}{.datatype} {Qd}, Qn, Qm
VBIC{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional data type. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VBIC performs a bitwise logical AND complement between two registers, and places the results in
the destination register.
Related references
10.8 Condition codes on page 10-317.
12.19 VBIF
Vector Bitwise Insert if False.
Syntax
VBIF{cond}{.datatype} {Qd}, Qn, Qm
VBIF{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VBIF inserts each bit from the first operand into the destination if the corresponding bit of the
second operand is 0, otherwise it leaves the destination bit unchanged.
Related references
10.8 Condition codes on page 10-317.
12.20 VBIT
Vector Bitwise Insert if True.
Syntax
VBIT{cond}{.datatype} {Qd}, Qn, Qm
VBIT{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VBIT inserts each bit from the first operand into the destination if the corresponding bit of the
second operand is 1, otherwise it leaves the destination bit unchanged.
Related references
10.8 Condition codes on page 10-317.
12.21 VBSL
Vector Bitwise Select.
Syntax
VBSL{cond}{.datatype} {Qd}, Qn, Qm
VBSL{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VBSL selects each bit for the destination from the first operand if the corresponding bit of the
destination is 1, or from the second operand if the corresponding bit of the destination is 0.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCEQ{cond}.datatype {Qd}, Qn, #0
VCEQ{cond}.datatype {Dd}, Dn, #0
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, or F32.
The result datatype is:
• I32 for operand datatypes I32 or F32.
• I16 for operand datatype I16.
• I8 for operand datatype I8.
Qd, Qn, Qm
specifies the destination register and the operand register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register and the operand register, for a doubleword operation.
#0
specifies a comparison with zero.
Operation
VCEQ takes the value of each element in a vector, and compares it with zero. If the condition is
true, the corresponding element in the destination vector is set to all ones. Otherwise, it is set to all
zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCEQ{cond}.datatype {Qd}, Qn, Qm
VCEQ{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, or F32.
The result datatype is:
• I32 for operand datatypes I32 or F32.
• I16 for operand datatype I16.
• I8 for operand datatype I8.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VCEQ takes the value of each element in a vector, and compares it with the value of the
corresponding element of a second vector. If the condition is true, the corresponding element in
the destination vector is set to all ones. Otherwise, it is set to all zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCGE{cond}.datatype {Qd}, Qn, #0
VCGE{cond}.datatype {Dd}, Dn, #0
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
The result datatype is:
• I32 for operand datatypes S32 or F32.
• I16 for operand datatype S16.
• I8 for operand datatype S8.
Qd, Qn, Qm
specifies the destination register and the operand register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register and the operand register, for a doubleword operation.
#0
specifies a comparison with zero.
Operation
VCGE takes the value of each element in a vector, and compares it with zero. If the condition is
true, the corresponding element in the destination vector is set to all ones. Otherwise, it is set to all
zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCGE{cond}.datatype {Qd}, Qn, Qm
VCGE{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
The result datatype is:
• I32 for operand datatypes S32, U32, or F32.
• I16 for operand datatypes S16 or U16.
• I8 for operand datatypes S8 or U8.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VCGE takes the value of each element in a vector, and compares it with the value of the
corresponding element of a second vector. If the condition is true, the corresponding element in
the destination vector is set to all ones. Otherwise, it is set to all zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCGT{cond}.datatype {Qd}, Qn, #0
VCGT{cond}.datatype {Dd}, Dn, #0
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
The result datatype is:
• I32 for operand datatypes S32 or F32.
• I16 for operand datatype S16.
• I8 for operand datatype S8.
Qd, Qn, Qm
specifies the destination register and the operand register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register and the operand register, for a doubleword operation.
Operation
VCGT takes the value of each element in a vector, and compares it with zero. If the condition is
true, the corresponding element in the destination vector is set to all ones. Otherwise, it is set to all
zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCGT{cond}.datatype {Qd}, Qn, Qm
VCGT{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
The result datatype is:
• I32 for operand datatypes S32, U32, or F32.
• I16 for operand datatypes S16 or U16.
• I8 for operand datatypes S8 or U8.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VCGT takes the value of each element in a vector, and compares it with the value of the
corresponding element of a second vector. If the condition is true, the corresponding element in
the destination vector is set to all ones. Otherwise, it is set to all zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCLE{cond}.datatype {Qd}, Qn, #0
VCLE{cond}.datatype {Dd}, Dn, #0
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
The result datatype is:
• I32 for operand datatypes S32 or F32.
• I16 for operand datatype S16.
• I8 for operand datatype S8.
Qd, Qn, Qm
specifies the destination register and the operand register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register and the operand register, for a doubleword operation.
#0
specifies a comparison with zero.
Operation
VCLE takes the value of each element in a vector, and compares it with zero. If the condition is
true, the corresponding element in the destination vector is set to all ones. Otherwise, it is set to all
zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.29 VCLE (register) on page 12-627.
12.32 VCLT (register) on page 12-630.
10.8 Condition codes on page 10-317.
Syntax
VCLE{cond}.datatype {Qd}, Qn, Qm
VCLE{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
The result datatype is:
• I32 for operand datatypes S32, U32, or F32.
• I16 for operand datatypes S16 or U16.
• I8 for operand datatypes S8 or U8.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VCLE takes the value of each element in a vector, and compares it with the value of the
corresponding element of a second vector. If the condition is true, the corresponding element in
the destination vector is set to all ones. Otherwise, it is set to all zeros.
On disassembly, this pseudo-instruction is disassembled to the corresponding VCGE instruction,
with the operands reversed.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.30 VCLS
Vector Count Leading Sign bits.
Syntax
VCLS{cond}.datatype Qd, Qm
VCLS{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, or S32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VCLS counts the number of consecutive bits following the topmost bit, that are the same as the
topmost bit, in each element in a vector, and places the results in a second vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCLT{cond}.datatype {Qd}, Qn, #0
VCLT{cond}.datatype {Dd}, Dn, #0
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
The result datatype is:
• I32 for operand datatypes S32 or F32.
• I16 for operand datatype S16.
• I8 for operand datatype S8.
Qd, Qn, Qm
specifies the destination register and the operand register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register and the operand register, for a doubleword operation.
#0
specifies a comparison with zero.
Operation
VCLT takes the value of each element in a vector, and compares it with zero. If the condition is
true, the corresponding element in the destination vector is set to all ones. Otherwise, it is set to all
zeros.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCLT{cond}.datatype {Qd}, Qn, Qm
VCLT{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
The result datatype is:
• I32 for operand datatypes S32, U32, or F32.
• I16 for operand datatypes S16 or U16.
• I8 for operand datatypes S8 or U8.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VCLT takes the value of each element in a vector, and compares it with the value of the
corresponding element of a second vector. If the condition is true, the corresponding element in
the destination vector is set to all ones. Otherwise, it is set to all zeros.
Note
On disassembly, this pseudo-instruction is disassembled to the corresponding VCGT instruction,
with the operands reversed.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.33 VCLZ
Vector Count Leading Zeros.
Syntax
VCLZ{cond}.datatype Qd, Qm
VCLZ{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, or I32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VCLZ counts the number of consecutive zeros, starting from the top bit, in each element in a
vector, and places the results in a second vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCMP{E}{cond}.F32 Sd, Sm
VCMP{E}{cond}.F32 Sd, #0
VCMP{E}{cond}.F64 Dd, Dm
VCMP{E}{cond}.F64 Dd, #0
where:
E
if present, indicates that the instruction raises an Invalid Operation exception if either
operand is a quiet or signaling NaN. Otherwise, it raises the exception only if either
operand is a signaling NaN.
cond
is an optional condition code.
Sd, Sm
are the single-precision registers holding the operands.
Dd, Dm
are the double-precision registers holding the operands.
Operation
The VCMP{E} instruction subtracts the value in the second operand register (or 0 if the second
operand is #0) from the value in the first operand register, and sets the VFP condition flags based
on the result.
VCMP and VCMPE are always scalar.
Floating-point exceptions
VCMP{E} instructions can produce Invalid Operation exceptions.
Related references
10.8 Condition codes on page 10-317.
12.35 VCNT
Vector Count set bits.
Syntax
VCNT{cond}.datatype Qd, Qm
VCNT{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be I8.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VCNT counts the number of bits that are one in each element in a vector, and places the results in a
second vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVT{cond}.type Qd, Qm {, #fbits}
VCVT{cond}.type Dd, Dm {, #fbits}
where:
cond
is an optional condition code.
type
specifies the data types for the elements of the vectors. It must be one of:
S32.F32
Floating-point to signed integer or fixed-point.
U32.F32
Floating-point to unsigned integer or fixed-point.
F32.S32
Signed integer or fixed-point to floating-point.
F32.U32
Unsigned integer or fixed-point to floating-point.
Qd, Qm
specifies the destination vector and the operand vector, for a quadword operation.
Dd, Dm
specifies the destination vector and the operand vector, for a doubleword operation.
fbits
if present, specifies the number of fraction bits in the fixed point number. Otherwise, the
conversion is between floating-point and integer. fbits must lie in the range 0-32. If
fbits is omitted, the number of fraction bits is 0.
Operation
VCVT converts each element in a vector in one of the following ways, and places the results in the
destination vector:
• From floating-point to integer.
• From integer to floating-point.
• From floating-point to fixed-point.
• From fixed-point to floating-point.
Rounding
Integer or fixed-point to floating-point conversions use round to nearest.
Floating-point to integer or fixed-point conversions use round towards zero.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVT{cond}.F32.F16 Qd, Dm
VCVT{cond}.F16.F32 Dd, Qm
where:
cond
is an optional condition code.
Qd, Dm
specifies the destination vector for the single-precision results and the half-precision
operand vector.
Dd, Qm
specifies the destination vector for half-precision results and the single-precision operand
vector.
Operation
VCVT with half-precision extension, converts each element in a vector in one of the following
ways, and places the results in the destination vector:
• From half-precision floating-point to single-precision floating-point (F32.F16).
• From single-precision floating-point to half-precision floating-point (F16.F32).
Architectures
This instruction is only available in NEON systems with the half-precision extension.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVT{cond}.F64.F32 Dd, Sm
VCVT{cond}.F32.F64 Sd, Dm
where:
cond
is an optional condition code.
Dd
is a double-precision register for the result.
Sm
is a single-precision register holding the operand.
Sd
is a single-precision register for the result.
Dm
is a double-precision register holding the operand.
Operation
These instructions convert the single-precision value in Sm to double-precision, placing the result
in Dd, or the double-precision value in Dm to single-precision, placing the result in Sd.
These instructions are always scalar.
Floating-point exceptions
These instructions can produce Invalid Operation, Input Denormal, Overflow, Underflow, or
Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVT{R}{cond}.type.F64 Sd, Dm
VCVT{R}{cond}.type.F32 Sd, Sm
VCVT{cond}.F64.type Dd, Sm
VCVT{cond}.F32.type Sd, Sm
where:
R
makes the operation use the rounding mode specified by the FPSCR. Otherwise, the
operation rounds towards zero.
cond
is an optional condition code.
type
can be either U32 (unsigned 32-bit integer) or S32 (signed 32-bit integer).
Sd
is a single-precision register for the result.
Dd
is a double-precision register for the result.
Sm
is a single-precision register holding the operand.
Dm
is a double-precision register holding the operand.
Operation
The first two forms of this instruction convert from floating-point to integer.
The third and fourth forms convert from integer to floating-point.
VCVT is always scalar.
Floating-point exceptions
These instructions can produce Input Denormal, Invalid Operation, or Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVT{cond}.type.F64 Dd, Dd, #fbits
VCVT{cond}.type.F32 Sd, Sd, #fbits
VCVT{cond}.F64.type Dd, Dd, #fbits
VCVT{cond}.F32.type Sd, Sd, #fbits
where:
cond
is an optional condition code.
type
can be any one of:
S16
16-bit signed fixed-point number.
U16
16-bit unsigned fixed-point number.
S32
32-bit signed fixed-point number.
U32
32-bit unsigned fixed-point number.
Sd
is a single-precision register for the operand and result.
Dd
is a double-precision register for the operand and result.
fbits
is the number of fraction bits in the fixed-point number, in the range 0-16 if type is S16
or U16, or in the range 1-32 if type is S32 or U32.
Operation
The first two forms of this instruction convert from floating-point to fixed-point.
The third and fourth forms convert from fixed-point to floating-point.
In all cases the fixed-point number is contained in the least significant 16 or 32 bits of the register.
VCVT is always scalar.
Floating-point exceptions
These instructions can produce Input Denormal, Invalid Operation, or Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VCVTB{cond}.type Sd, Sm
VCVTT{cond}.type Sd, Sm
where:
cond
is an optional condition code.
type
can be any one of:
F32.F16
Convert from half-precision to single-precision.
F16.F32
Convert from single-precision to half-precision.
Sd
is a single word register for the result.
Sm
is a single word register for the operand.
Operation
VCVTB uses the bottom half (bits[15:0]) of the single word register to obtain or store the half-
precision value
VCVTT uses the top half (bits[31:16]) of the single word register to obtain or store the half-
precision value.
VCVTB and VCVTT are always scalar.
Architectures
The instructions are only available in VFPv3 systems with the half-precision extension, and
VFPv4.
Floating-point exceptions
These instructions can produce Input Denormal, Invalid Operation, Overflow, Underflow, or
Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
12.42 VDIV
Floating-point divide.
Syntax
VDIV{cond}.F32 {Sd}, Sn, Sm
VDIV{cond}.F64 {Dd}, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VDIV instruction divides the value in the first operand register by the value in the second
operand register, and places the result in the destination register.
Floating-point exceptions
VDIV operations can produce Division by Zero, Invalid Operation, Overflow, Underflow, or
Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
12.43 VDUP
Vector Duplicate.
Syntax
VDUP{cond}.size Qd, Dm[x]
VDUP{cond}.size Dd, Dm[x]
VDUP{cond}.size Qd, Rm
VDUP{cond}.size Dd, Rm
where:
cond
is an optional condition code.
size
must be 8, 16, or 32.
Qd
specifies the destination register for a quadword operation.
Dd
specifies the destination register for a doubleword operation.
Dm[x]
specifies the NEON scalar.
Rm
specifies the ARM register. Rm must not be PC.
Operation
VDUP duplicates a scalar into every element of the destination vector. The source can be a NEON
scalar or an ARM register.
Related references
10.8 Condition codes on page 10-317.
12.44 VEOR
Vector Bitwise Exclusive OR.
Syntax
VEOR{cond}{.datatype} {Qd}, Qn, Qm
VEOR{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional data type. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VEOR performs a logical exclusive OR between two registers, and places the result in the
destination register.
Related references
10.8 Condition codes on page 10-317.
12.45 VEXT
Vector Extract.
Syntax
VEXT{cond}.8 {Qd}, Qn, Qm, #imm
VEXT{cond}.8 {Dd}, Dn, Dm, #imm
where:
cond
is an optional condition code.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
imm
is the number of 8-bit elements to extract from the bottom of the second operand vector,
in the range 0-7 for doubleword operations, or 0-15 for quadword operations.
Operation
VEXT extracts 8-bit elements from the bottom end of the second operand vector and the top end of
the first, concatenates them, and places the result in the destination vector. See the following
figure for an example:
7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
Vm Vn
Vd
VEXT pseudo-instruction
You can specify a datatype of 16, 32, or 64 instead of 8. In this case, #imm refers to halfwords,
words, or doublewords instead of referring to bytes, and the permitted ranges are correspondingly
reduced.
Related references
10.8 Condition codes on page 10-317.
Syntax
Vop{cond}.F32 {Qd}, Qn, Qm
Vop{cond}.F32 {Dd}, Dn, Dm
where:
op
is one of FMA or FMS.
cond
is an optional condition code.
Dd, Dn, Dm
are the destination and operand vectors for doubleword operation.
Qd, Qn, Qm
are the destination and operand vectors for quadword operation.
Operation
VFMA multiplies corresponding elements in the two operand vectors, and accumulates the results
into the elements of the destination vector. The result of the multiply is not rounded before the
accumulation.
VFMS multiplies corresponding elements in the two operand vectors, then subtracts the products
from the corresponding elements of the destination vector, and places the final results in the
destination vector. The result of the multiply is not rounded before the subtraction.
Related references
12.79 VMUL on page 12-680.
10.8 Condition codes on page 10-317.
Syntax
VF{N}op{cond}.F64 {Dd}, Dn, Dm
VF{N}op{cond}.F32 {Sd}, Sn, Sm
where:
op
is one of MA or MS.
N
negates the final result.
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Qd, Qn, Qm
are the double-precision registers for the result and operands.
Operation
VFMA multiplies the values in the operand registers, adds the value in the destination register, and
places the final result in the destination register. The result of the multiply is not rounded before
the accumulation.
VFMS multiplies the values in the operand registers, subtracts the product from the value in the
destination register, and places the final result in the destination register. The result of the multiply
is not rounded before the subtraction.
In each case, the final result is negated if the N option is used.
These instructions are always scalar.
Floating-point exceptions
These instructions can produce Input Denormal, Invalid Operation, Overflow, Underflow, or
Inexact exceptions.
Related references
12.80 VMUL (floating-point) on page 12-681.
10.8 Condition codes on page 10-317.
12.48 VHADD
Vector Halving Add.
Syntax
VHADD{cond}.datatype {Qd}, Qn, Qm
VHADD{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VHADD adds corresponding elements in two vectors, shifts each result right one bit, and places the
results in the destination vector. Results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.49 VHSUB
Vector Halving Subtract.
Syntax
VHSUB{cond}.datatype {Qd}, Qn, Qm
VHSUB{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VHSUB subtracts the elements of one vector from the corresponding elements of another vector,
shifts each result right one bit, and places the results in the destination vector. Results are always
truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VLDn{cond}.datatype list, [Rn{@align}]{!}
VLDn{cond}.datatype list, [Rn{@align}], Rm
where:
n
must be one of 1, 2, 3, or 4.
cond
is an optional condition code.
datatype
see the following table.
list
specifies the NEON register list. See the following table for options.
Rn
is the ARM register containing the base address. Rn cannot be PC.
align
specifies an optional alignment. See the following table for options.
!
if ! is present, Rn is updated to (Rn + the number of bytes transferred by the instruction).
The update occurs after all the loads have taken place.
Rm
is an ARM register containing an offset from the base address. If Rm is present, the
instruction updates Rn to (Rn + Rm) after using the address to access memory. Rm cannot
be SP or PC.
Operation
VLDn loads one n-element structure from memory into one or more NEON registers. Elements of
the register that are not loaded are unaltered.
Table 12-5 Permitted combinations of parameters for VLDn (single n-element structure to
one lane)
Table 12-5 Permitted combinations of parameters for VLDn (single n-element structure to one
lane) (continued)
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
12.52 VLDn (multiple n-element structures) on page 12-652.
10.8 Condition codes on page 10-317.
Syntax
VLDn{cond}.datatype list, [Rn{@align}]{!}
VLDn{cond}.datatype list, [Rn{@align}], Rm
where:
n
must be one of 1, 2, 3, or 4.
cond
is an optional condition code.
datatype
see the following table.
list
specifies the NEON register list. See the following table for options.
Rn
is the ARM register containing the base address. Rn cannot be PC.
align
specifies an optional alignment. See the following table for options.
!
if ! is present, Rn is updated to (Rn + the number of bytes transferred by the instruction).
The update occurs after all the loads have taken place.
Rm
is an ARM register containing an offset from the base address. If Rm is present, the
instruction updates Rn to (Rn + Rm) after using the address to access memory. Rm cannot
be SP or PC.
Operation
VLDn loads multiple copies of one n-element structure from memory into one or more NEON
registers.
Table 12-6 Permitted combinations of parameters for VLDn (single n-element structure to
all lanes)
Table 12-6 Permitted combinations of parameters for VLDn (single n-element structure to all
lanes) (continued)
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.50 VLDn (single n-element structure to one lane) on page 12-648.
12.52 VLDn (multiple n-element structures) on page 12-652.
10.8 Condition codes on page 10-317.
Syntax
VLDn{cond}.datatype list, [Rn{@align}]{!}
VLDn{cond}.datatype list, [Rn{@align}], Rm
where:
n
must be one of 1, 2, 3, or 4.
cond
is an optional condition code.
datatype
see the following table for options.
list
specifies the NEON register list. See the following table for options.
Rn
is the ARM register containing the base address. Rn cannot be PC.
align
specifies an optional alignment. See the following table for options.
!
if ! is present, Rn is updated to (Rn + the number of bytes transferred by the instruction).
The update occurs after all the loads have taken place.
Rm
is an ARM register containing an offset from the base address. If Rm is present, the
instruction updates Rn to (Rn + Rm) after using the address to access memory. Rm cannot
be SP or PC.
Operation
VLDn loads multiple n-element structures from memory into one or more NEON registers, with
de-interleaving (unless n == 1). Every element of each register is loaded.
Table 12-7 Permitted combinations of parameters for VLDn (multiple n-element structures)
Table 12-7 Permitted combinations of parameters for VLDn (multiple n-element structures) (continued)
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.50 VLDn (single n-element structure to one lane) on page 12-648.
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
10.8 Condition codes on page 10-317.
12.53 VLDM
Extension register load multiple.
Syntax
VLDMmode{cond} Rn{!}, Registers
where:
mode
must be one of:
IA
meaning Increment address After each transfer. IA is the default, and can be
omitted.
DB
meaning Decrement address Before each transfer.
EA
meaning Empty Ascending stack operation. This is the same as DB for loads.
FD
meaning Full Descending stack operation. This is the same as IA for loads.
cond
is an optional condition code.
Rn
is the ARM register holding the base address for the transfer.
!
is optional. ! specifies that the updated base address must be written back to Rn. If ! is
not specified, mode must be IA.
Registers
is a list of consecutive extension registers enclosed in braces, { and }. The list can be
comma-separated, or in range format. There must be at least one register in the list.
You can specify S, D, or Q registers, but they must not be mixed. The number of registers
must not exceed 16 D registers, or 8 Q registers. If Q registers are specified, on
disassembly they are shown as D registers.
Note
VPOP Registers is equivalent to VLDM sp!, Registers.
You can use either form of this instruction. They both disassemble to VPOP.
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.8 Condition codes on page 10-317.
12.54 VLDR
Extension register load.
Syntax
VLDR{cond}{.size} Fd, [Rn{, #offset}]
VLDR{cond}{.size} Fd, label
where:
cond
is an optional condition code.
size
is an optional data size specifier. Must be 32 if Fd is an S register, or 64 otherwise.
Fd
is the extension register to be loaded. For a NEON instruction, it must be a D register. For
a VFP instruction, it can be either a D or S register.
Rn
is the ARM register holding the base address for the transfer.
offset
is an optional numeric expression. It must evaluate to a numeric value at assembly time.
The value must be a multiple of 4, and lie in the range –1020 to +1020. The value is
added to the base address to form the address used for the transfer.
label
is a PC-relative expression.
label must be aligned on a word boundary within ±1KB of the current instruction.
Operation
The VLDR instruction loads an extension register from memory.
One word is transferred if Fd is an S register (VFP only). Two words are transferred otherwise.
There is also a VLDR pseudo-instruction.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
12.56 VLDR pseudo-instruction on page 12-657.
10.8 Condition codes on page 10-317.
Note
There are also VLDR and VSTR instructions without post-increment and pre-decrement.
Syntax
VLDR{cond}{.size} Fd, [Rn], #offset ; post-increment
VLDR{cond}{.size} Fd, [Rn, #-offset]! ; pre-decrement
where:
cond
is an optional condition code.
size
is an optional data size specifier. Must be 32 if Fd is an S register, or 64 if Fd is a D
register.
Fd
is the extension register to load. For a NEON instruction, it must be a doubleword (Dd)
register. For a VFP instruction, it can be either a double precision (Dd) or a single
precision (Sd) register.
Rn
is the ARM register holding the base address for the transfer.
offset
is a numeric expression that must evaluate to a numeric value at assembly time. The
value must be 4 if Fd is an S register, or 8 if Fd is a D register.
Operation
The post-increment instruction increments the base address in the register by the offset value, after
the transfer. The pre-decrement instruction decrements the base address in the register by the
offset value, and then performs the transfer using the new address in the register. This pseudo-
instruction assembles to a VLDM instruction.
Related references
12.53 VLDM on page 12-654.
12.54 VLDR on page 12-655.
10.8 Condition codes on page 10-317.
Note
This section describes the VLDR pseudo-instruction only.
Syntax
VLDR{cond}.datatype Dd,=constant
VLDR{cond}.datatype Sd,=constant
where:
datatype
must be one of:
In
NEON only.
Sn
NEON only.
Un
NEON only.
F32
NEON or VFP.
F64
VFP only.
n
must be one of 8, 16, 32, or 64.
cond
is an optional condition code.
Dd or Sd
is the extension register to be loaded.
constant
is an immediate value of the appropriate type for datatype.
Operation
If an instruction (for example, VMOV) is available that can generate the constant directly into the
register, the assembler uses it. Otherwise, the assembler generates a doubleword literal pool entry
containing the constant and loads the constant using a VLDR instruction.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.54 VLDR on page 12-655.
10.8 Condition codes on page 10-317.
Syntax
Vop{cond}.datatype Qd, Qn, Qm
Vop{cond}.datatype Dd, Dn, Dm
where:
op
must be either MAX or MIN.
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VMAX compares corresponding elements in two vectors, and copies the larger of each pair into the
corresponding element in the destination vector.
VMIN compares corresponding elements in two vectors, and copies the smaller of each pair into
the corresponding element in the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.96 VPADD on page 12-697.
10.8 Condition codes on page 10-317.
12.58 VMLA
Vector Multiply Accumulate.
Syntax
VMLA{cond}.datatype {Qd}, Qn, Qm
VMLA{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, or F32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VMLA multiplies corresponding elements in two vectors, and accumulates the results into the
elements of the destination vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLA{cond}.datatype {Qd}, Qn, Dm[x]
VMLA{cond}.datatype {Dd}, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or F32.
Qd, Qn
are the destination vector and the first operand vector, for a quadword operation.
Dd, Dn
are the destination vector and the first operand vector, for a doubleword operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMLA multiplies each element in a vector by a scalar, and accumulates the results into the
corresponding elements of the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLA{cond}.F32 Sd, Sn, Sm
VMLA{cond}.F64 Dd, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VMLA instruction multiplies the values in the operand registers, adds the value in the
destination register, and places the final result in the destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLAL{cond}.datatype Qd, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of S16, S32, U16, or U32
Qd, Dn
are the destination vector and the first operand vector, for a long operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMLAL multiplies each element in a vector by a scalar, and accumulates the results into the
corresponding elements of the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.62 VMLAL
Vector Multiply Accumulate Long.
Syntax
VMLAL{cond}.datatype Qd, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32,U8, U16, or U32.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Operation
VMLAL multiplies corresponding elements in two vectors, and accumulates the results into the
elements of the destination vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLS{cond}.datatype {Qd}, Qn, Dm[x]
VMLS{cond}.datatype {Dd}, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or F32.
Qd, Qn
are the destination vector and the first operand vector, for a quadword operation.
Dd, Dn
are the destination vector and the first operand vector, for a doubleword operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMLS multiplies each element in a vector by a scalar, subtracts the results from the corresponding
elements of the destination vector, and places the final results in the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.64 VMLS
Vector Multiply Subtract.
Syntax
VMLS{cond}.datatype {Qd}, Qn, Qm
VMLS{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, F32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VMLS multiplies corresponding elements in two vectors, subtracts the results from corresponding
elements of the destination vector, and places the final results in the destination vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLS{cond}.F32 Sd, Sn, Sm
VMLS{cond}.F64 Dd, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VMLS instruction multiplies the values in the operand registers, subtracts the result from the
value in the destination register, and places the final result in the destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
12.66 VMLSL
Vector Multiply Subtract Long.
Syntax
VMLSL{cond}.datatype Qd, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Operation
VMLSL multiplies corresponding elements in two vectors, subtracts the results from corresponding
elements of the destination vector, and places the final results in the destination vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMLSL{cond}.datatype Qd, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of S16, S32, U16, or U32.
Qd, Dn
are the destination vector and the first operand vector, for a long operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMLSL multiplies each element in a vector by a scalar, subtracts the results from the corresponding
elements of the destination vector, and places the final results in the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMOV{cond}.F32 Sd, #imm
VMOV{cond}.F64 Dd, #imm
VMOV{cond}.F32 Sd, Sm
VMOV{cond}.F64 Dd, Dm
where:
cond
is an optional condition code.
Sd
is the single-precision destination register.
Dd
is the double-precision destination register.
imm
is the floating-point immediate value.
Sm
is the single-precision source register.
Dm
is the double-precision source register.
Immediate values
Any number that can be expressed as +/–n * 2–r,where n and r are integers, 16 <= n <= 31, 0 <= r
<= 7.
Architectures
The instructions that copy immediate constants are available in VFPv3 and above.
The instructions that copy from registers are available in all VFP systems.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMOV{cond}.datatype Qd, #imm
VMOV{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, I64, or F32.
Qd or Dd
is the NEON register for the result.
imm
is an immediate value of the type specified by datatype. This is replicated to fill the
destination register.
Operation
VMOV replicates an immediate value in every element of the destination register.
datatype VMOV
I8 0xXY
I16 0x00XY, 0xXY00
I32 0x000000XY, 0x0000XY00, 0x00XY0000, 0xXY000000
0x0000XYFF, 0x00XYFFFF
I64 byte masks, 0xGGHHJJKKLLMMNNPP bf
F32 floating-point numbers bg
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
bf Each of 0xGG, 0xHH, 0xJJ, 0xKK, 0xLL, 0xMM, 0xNN, and 0xPP must be either 0x00 or 0xFF.
bg Any number that can be expressed as +/–n * 2–r, where n and r are integers, 16 <= n <= 31, 0 <= r <= 7.
Syntax
VMOV{cond}{.datatype} Qd, Qm
VMOV{cond}{.datatype} Dd, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qm
specifies the destination vector and the source vector, for a quadword operation.
Dd, Dm
specifies the destination vector and the source vector, for a doubleword operation.
Operation
VMOV copies the contents of the source register into the destination register.
Related references
10.8 Condition codes on page 10-317.
12.71 VMOV (between one ARM register and single precision VFP)
Transfer contents between a single-precision floating-point register and an ARM register.
Syntax
VMOV{cond} Rd, Sn
VMOV{cond} Sn, Rd
where:
cond
is an optional condition code.
Sn
is the VFP single-precision register.
Rd
is the ARM register. Rd must not be PC.
Operation
VMOV Rd, Sn transfers the contents of Sn into Rd.
VMOV Sn, Rd transfers the contents of Rd into Sn.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMOV{cond} Dm, Rd, Rn
VMOV{cond} Rd, Rn, Dm
VMOV{cond} Sm, Sm1, Rd, Rn
VMOV{cond} Rd, Rn, Sm, Sm1
where:
cond
is an optional condition code.
Dm
is a 64-bit extension register.
Sm
is a VFP 32-bit register.
Sm1
is the next consecutive VFP 32-bit register after Sm.
Rd, Rn
are the ARM registers. Rd and Rn must not be PC.
Operation
VMOV Dm, Rd, Rn transfers the contents of Rd into the low half of Dm, and the contents of Rn
into the high half of Dm.
VMOV Rd, Rn, Dm transfers the contents of the low half of Dm into Rd, and the contents of the
high half of Dm into Rn.
VMOV Rd, Rn, Sm, Sm1 transfers the contents of Sm into Rd, and the contents of Sm1 into Rn.
VMOV Sm, Sm1, Rd, Rn transfers the contents of Rd into Sm, and the contents of Rn into Sm1.
Architectures
The 64-bit instructions are available in:
• NEON.
• VFPv2 and above.
The 2 x 32-bit instructions are available in VFPv2 and above.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMOV{cond}{.size} Dn[x], Rd
VMOV{cond}{.datatype} Rd, Dn[x]
where:
cond
is an optional condition code.
size
the data size. Can be 8, 16, or 32. If omitted, size is 32. For VFP instructions, size
must be 32 or omitted.
datatype
the data type. Can be U8, S8, U16, S16, or 32. If omitted, datatype is 32. For VFP
instructions, datatype must be 32 or omitted.
Dn[x]
is the NEON scalar.
Rd
is the ARM register. Rd must not be PC.
Operation
VMOV Dn[x], Rd transfers the contents of the least significant byte, halfword, or word of Rd into
Dn[x].
VMOV Rd, Dn[x] transfers the contents of Dn[x] into the least significant byte, halfword, or
word of Rd. The remaining bits of Rd are either zero or sign extended.
Related concepts
8.14 NEON scalars on page 8-191.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.74 VMOVL
Vector Move Long.
Syntax
VMOVL{cond}.datatype Qd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Dm
specifies the destination vector and the operand vector.
Operation
VMOVL takes each element in a doubleword vector, sign or zero extends them to twice their
original length, and places the results in a quadword vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.75 VMOVN
Vector Move and Narrow.
Syntax
VMOVN{cond}.datatype Dd, Qm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qm
specifies the destination vector and the operand vector.
Operation
VMOVN copies the least significant half of each element of a quadword vector into the
corresponding elements of a doubleword vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.76 VMOV2
Pseudo-instruction that generates an immediate value and places it in every element of a NEON
vector, without loading a value from a literal pool.
Syntax
VMOV2{cond}.datatype Qd, #constant
VMOV2{cond}.datatype Dd, #constant
where:
datatype
must be one of:
• I8, I16, I32, or I64.
• S8, S16, S32, or S64.
• U8, U16, U32, or U64.
• F32.
cond
is an optional condition code.
Qd or Dd
is the extension register to be loaded.
constant
is an immediate value of the appropriate type for datatype.
Operation
VMOV2 can generate any 16-bit immediate value, and a restricted range of 32-bit and 64-bit
immediate values.
VMOV2 is a pseudo-instruction that always assembles to exactly two instructions. It typically
assembles to a VMOV or VMVN instruction, followed by a VBIC or VORR instruction.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.69 VMOV (immediate) on page 12-670.
12.17 VBIC (immediate) on page 12-615.
10.8 Condition codes on page 10-317.
12.77 VMRS
Transfer the contents of a NEON and VFP system register to an ARM register.
Syntax
VMRS{cond} Rd, extsysreg
where:
cond
is an optional condition code.
extsysreg
is the NEON and VFP system register, usually FPSCR, FPSID, or FPEXC.
Rd
is the ARM register. Rd must not be PC.
It can be APSR_nzcv, if extsysreg is FPSCR. In this case, the floating-point status
flags are transferred into the corresponding flags in the ARM APSR.
Operation
The VMRS instruction transfers the contents of extsysreg into Rd.
Note
This instruction stalls the processor until all current NEON or VFP operations complete.
Examples
VMRS r2,FPCID
VMRS APSR_nzcv, FPSCR ; transfer FP status register to ARM APSR
Related references
8.17 NEON and VFP system registers on page 8-194.
10.8 Condition codes on page 10-317.
12.78 VMSR
Transfer the contents of an ARM register to a NEON and VFP system register.
Syntax
VMSR{cond} extsysreg, Rd
where:
cond
is an optional condition code.
extsysreg
is the NEON and VFP system register, usually FPSCR, FPSID, or FPEXC.
Rd
is the ARM register. Rd must not be PC.
Operation
The VMSR instruction transfers the contents of Rd into extsysreg.
Note
This instruction stalls the processor until all current NEON or VFP operations complete.
Example
VMSR FPSCR, r4
Related references
8.17 NEON and VFP system registers on page 8-194.
10.8 Condition codes on page 10-317.
12.79 VMUL
Vector Multiply.
Syntax
VMUL{cond}.datatype {Qd}, Qn, Qm
VMUL{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, F32, or P8.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VMUL multiplies corresponding elements in two vectors, and places the results in the destination
vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMUL{cond}.F32 {Sd,} Sn, Sm
VMUL{cond}.F64 {Dd,} Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VMUL operation multiplies the values in the operand registers and places the result in the
destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMUL{cond}.datatype {Qd}, Qn, Dm[x]
VMUL{cond}.datatype {Dd}, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or F32.
Qd, Qn
are the destination vector and the first operand vector, for a quadword operation.
Dd, Dn
are the destination vector and the first operand vector, for a doubleword operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMUL multiplies each element in a vector by a scalar, and places the results in the destination
vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.82 VMULL
Vector Multiply Long
Syntax
VMULL{cond}.datatype Qd, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of U8, U16, U32, S8, S16, S32, or P8.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Operation
VMULL multiplies corresponding elements in two vectors, and places the results in the destination
vector.
Related concepts
8.16 Polynomial arithmetic over {0,1} on page 8-193.
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMULL{cond}.datatype Qd, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be one of S16, S32, U16, or U32.
Qd, Dn
are the destination vector and the first operand vector, for a long operation.
Dm[x]
is the scalar holding the second operand.
Operation
VMULL multiplies each element in a vector by a scalar, and places the results in the destination
vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMVN{cond}{.datatype} Qd, Qm
VMVN{cond}{.datatype} Dd, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qm
specifies the destination vector and the source vector, for a quadword operation.
Dd, Dm
specifies the destination vector and the source vector, for a doubleword operation.
Operation
VMVN inverts the value of each bit from the source register and places the results into the
destination register.
Related references
10.8 Condition codes on page 10-317.
Syntax
VMVN{cond}.datatype Qd, #imm
VMVN{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, I64, or F32.
Qd or Dd
is the NEON register for the result.
imm
is an immediate value of the type specified by datatype. This is replicated to fill the
destination register.
Operation
VMVN inverts the value of each bit from an immediate value and places the results into each
element in the destination register.
datatype VMVN
I8 -
I16 0xFFXY, 0xXYFF
I32 0xFFFFFFXY, 0xFFFFXYFF, 0xFFXYFFFF, 0xXYFFFFFF
0xFFFFXY00, 0xFFXY0000
I64 -
F32 -
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VNEG{cond}.F32 Sd, Sm
VNEG{cond}.F64 Dd, Dm
where:
cond
is an optional condition code.
Sd, Sm
are the single-precision registers for the result and operand.
Dd, Dm
are the double-precision registers for the result and operand.
Operation
The VNEG instruction takes the contents of Sm or Dm, changes the sign bit, and places the result in
Sd or Dd. This gives the negation of the value.
If the operand is a NaN, the sign bit is determined as above, but no exception is produced.
Floating-point exceptions
VNEG instructions do not produce any exceptions.
Related references
10.8 Condition codes on page 10-317.
12.87 VNEG
Vector Negate.
Syntax
VNEG{cond}.datatype Qd, Qm
VNEG{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, or F32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VNEG negates each element in a vector, and places the results in a second vector. (The floating-
point version only inverts the sign bit.)
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.86 VNEG (floating-point) on page 12-687.
10.8 Condition codes on page 10-317.
Syntax
VNMLA{cond}.F32 Sd, Sn, Sm
VNMLA{cond}.F64 Dd, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VNMLA instruction multiplies the values in the operand registers, adds the value to the
destination register, and places the negated final result in the destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VNMLS{cond}.F32 Sd, Sn, Sm
VNMLS{cond}.F64 Dd, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VNMLS instruction multiplies the values in the operand registers, subtracts the result from the
value in the destination register, and places the negated final result in the destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VNMUL{cond}.F32 {Sd,} Sn, Sm
VNMUL{cond}.F64 {Dd,} Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VNMUL instruction multiplies the values in the operand registers and places the negated result
in the destination register.
Floating-point exceptions
This instruction can produce Invalid Operation, Overflow, Underflow, Inexact, or Input Denormal
exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VORN{cond}{.datatype} {Qd}, Qn, Qm
VORN{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional data type. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VORN performs a bitwise logical OR complement between two registers, and places the results in
the destination register.
Related references
10.8 Condition codes on page 10-317.
Syntax
VORN{cond}.datatype Qd, #imm
VORN{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be either I8, I16, I32, or I64.
Qd or Dd
is the NEON register for the result.
imm
is the immediate value.
Operation
VORN takes each element of the destination vector, performs a bitwise OR complement with an
immediate value, and returns the result in the destination vector.
Note
On disassembly, this pseudo-instruction is disassembled to a corresponding VORR instruction, with
a complementary immediate value.
Immediate values
If datatype is I16, the immediate value must have one of the following forms:
• 0xFFXY.
• 0xXYFF.
If datatype is I32, the immediate value must have one of the following forms:
• 0xFFFFFFXY.
• 0xFFFFXYFF.
• 0xFFXYFFFF.
• 0xXYFFFFFF.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.17 VBIC (immediate) on page 12-615.
10.8 Condition codes on page 10-317.
Syntax
VORR{cond}{.datatype} {Qd}, Qn, Qm
VORR{cond}{.datatype} {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
is an optional data type. The assembler ignores datatype.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Note
VORR with the same register for both operands is a VMOV instruction. You can use VORR in this
way, but disassembly of the resulting code produces the VMOV syntax.
Operation
VORR performs a bitwise logical OR between two registers, and places the result in the destination
register.
Related references
12.70 VMOV (register) on page 12-671.
10.8 Condition codes on page 10-317.
Syntax
VORR{cond}.datatype Qd, #imm
VORR{cond}.datatype Dd, #imm
where:
cond
is an optional condition code.
datatype
must be either I8, I16, I32, or I64.
Qd or Dd
is the NEON register for the source and result.
imm
is the immediate value.
Operation
VORR takes each element of the destination vector, performs a bitwise logical OR with an
immediate value, and places the result in the destination vector.
Immediate values
You can either specify imm as a pattern which the assembler repeats to fill the destination register,
or you can directly specify the immediate value (that conforms to the pattern) in full. The pattern
for imm depends on the datatype, as shown in the following table:
I16 I32
0x00XY 0x000000XY
0xXY00 0x0000XY00
0x00XY0000
0xXY000000
If you use the I8 or I64 datatypes, the assembler converts it to either the I16 or I32 instruction
to match the pattern of imm. If the immediate value does not match any of the patterns in the
preceding table, the assembler generates an error.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.15 VAND (immediate) on page 12-613.
10.8 Condition codes on page 10-317.
12.95 VPADAL
Vector Pairwise Add and Accumulate Long.
Syntax
VPADAL{cond}.datatype Qd, Qm
VPADAL{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qm
are the destination vector and the operand vector, for a quadword instruction.
Dd, Dm
are the destination vector and the operand vector, for a doubleword instruction.
Operation
VPADAL adds adjacent pairs of elements of a vector, and accumulates the absolute values of the
results into the elements of the destination vector.
Dm
+ +
Dd
Figure 12-3 Example of operation of VPADAL (in this case for data type I16)
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.96 VPADD
Vector Pairwise Add.
Syntax
VPADD{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, or F32.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector.
Operation
VPADD adds adjacent pairs of elements of two vectors, and places the results in the destination
vector.
Dm Dn
+ + + +
Dd
Figure 12-4 Example of operation of VPADD (in this case, for data type I16)
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.97 VPADDL
Vector Pairwise Add Long.
Syntax
VPADDL{cond}.datatype Qd, Qm
VPADDL{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qm
are the destination vector and the operand vector, for a quadword instruction.
Dd, Dm
are the destination vector and the operand vector, for a doubleword instruction.
Operation
VPADDL adds adjacent pairs of elements of a vector, sign or zero extends the results to twice their
original width, and places the final results in the destination vector.
Dm
+ +
Dd
Figure 12-5 Example of operation of doubleword VPADDL (in this case, for data type S16)
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VPop{cond}.datatype Dd, Dn, Dm
where:
op
must be either MAX or MIN.
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, U32, or F32.
Dd, Dn, Dm
are the destination doubleword vector, the first operand doubleword vector, and the
second operand doubleword vector.
Operation
VPMAX compares adjacent pairs of elements in two vectors, and copies the larger of each pair into
the corresponding element in the destination vector. Operands and results must be doubleword
vectors.
VPMIN compares adjacent pairs of elements in two vectors, and copies the smaller of each pair
into the corresponding element in the destination vector. Operands and results must be
doubleword vectors.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.96 VPADD on page 12-697.
10.8 Condition codes on page 10-317.
12.99 VPOP
Pop extension registers from the stack.
Syntax
VPOP{cond} Registers
where:
cond
is an optional condition code.
Registers
is a list of consecutive extension registers enclosed in braces, { and }. The list can be
comma-separated, or in range format. There must be at least one register in the list.
You can specify S, D, or Q registers, but they must not be mixed. The number of registers
must not exceed 16 D registers, or 8 Q registers. If Q registers are specified, on
disassembly they are shown as D registers.
Note
VPOP Registers is equivalent to VLDM sp!, Registers.
You can use either form of this instruction. They both disassemble to VPOP.
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.8 Condition codes on page 10-317.
12.100 VPUSH
Push extension registers onto the stack.
Syntax
VPUSH{cond} Registers
where:
cond
is an optional condition code.
Registers
is a list of consecutive extension registers enclosed in braces, { and }. The list can be
comma-separated, or in range format. There must be at least one register in the list.
You can specify S, D, or Q registers, but they must not be mixed. The number of registers
must not exceed 16 D registers, or 8 Q registers. If Q registers are specified, on
disassembly they are shown as D registers.
Note
VPUSH Registers is equivalent to VSTMDB sp!, Registers.
You can use either form of this instruction. They both disassemble to VPUSH.
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.8 Condition codes on page 10-317.
12.101 VQABS
Vector Saturating Absolute.
Syntax
VQABS{cond}.datatype Qd, Qm
VQABS{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, or S32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VQABS takes the absolute value of each element in a vector, and places the results in a second
vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.102 VQADD
Vector Saturating Add.
Syntax
VQADD{cond}.datatype {Qd}, Qn, Qm
VQADD{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VQADD adds corresponding elements in two vectors, and places the results in the destination
vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQDopL{cond}.datatype Qd, Dn, Dm
VQDopL{cond}.datatype Qd, Dn, Dm[x]
where:
op
must be one of:
MLA
Multiply Accumulate.
MLS
Multiply Subtract.
cond
is an optional condition code.
datatype
must be either S16 or S32.
Qd, Dn
are the destination vector and the first operand vector.
Dm
is the vector holding the second operand, for a by vector operation.
Dm[x]
is the scalar holding the second operand, for a by scalar operation.
Operation
These instructions multiply their operands and double the results. VQDMLAL adds the results to the
values in the destination register. VQDMLSL subtracts the results from the values in the destination
register.
If any of the results overflow, they are saturated. The sticky QC flag (FPSCR bit[27]) is set if
saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQDMULH{cond}.datatype {Qd}, Qn, Qm
VQDMULH{cond}.datatype {Dd}, Dn, Dm
VQDMULH{cond}.datatype {Qd}, Qn, Dm[x]
VQDMULH{cond}.datatype {Dd}, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be either S16 or S32.
Qd, Qn
are the destination vector and the first operand vector, for a quadword operation.
Dd, Dn
are the destination vector and the first operand vector, for a doubleword operation.
Qm or Dm
is the vector holding the second operand, for a by vector operation.
Dm[x]
is the scalar holding the second operand, for a by scalar operation.
Operation
VQDMULH multiplies corresponding elements in two vectors, doubles the results, and places the
most significant half of the final results in the destination vector.
The second operand can be a scalar instead of a vector.
If any of the results overflow, they are saturated. The sticky QC flag (FPSCR bit[27]) is set if
saturation occurs. Each result is truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQDMULL{cond}.datatype Qd, Dn, Dm
VQDMULL{cond}.datatype Qd, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be either S16 or S32.
Qd, Dn
are the destination vector and the first operand vector.
Dm
is the vector holding the second operand, for a by vector operation.
Dm[x]
is the scalar holding the second operand, for a by scalar operation.
Operation
VQDMULL multiplies corresponding elements in two vectors, doubles the results and places the
results in the destination register.
The second operand can be a scalar instead of a vector.
If any of the results overflow, they are saturated. The sticky QC flag (FPSCR bit[27]) is set if
saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQMOVN{cond}.datatype Dd, Qm
VQMOVUN{cond}.datatype Dd, Qm
where:
cond
is an optional condition code.
datatype
must be one of:
S16, S32, S64
for VQMOVN or VQMOVUN.
U16, U32, U64
for VQMOVN.
Dd, Qm
specifies the destination vector and the operand vector.
Operation
VQMOVN copies each element of the operand vector to the corresponding element of the destination
vector. The result element is half the width of the operand element, and values are saturated to the
result width. The results are the same type as the operands.
VQMOVUN copies each element of the operand vector to the corresponding element of the
destination vector. The result element is half the width of the operand element, and values are
saturated to the result width. The elements in the operand are signed and the elements in the result
are unsigned.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.107 VQNEG
Vector Saturating Negate.
Syntax
VQNEG{cond}.datatype Qd, Qm
VQNEG{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, or S32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VQNEG negates each element in a vector, and places the results in a second vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQRDMULH{cond}.datatype {Qd}, Qn, Qm
VQRDMULH{cond}.datatype {Dd}, Dn, Dm
VQRDMULH{cond}.datatype {Qd}, Qn, Dm[x]
VQRDMULH{cond}.datatype {Dd}, Dn, Dm[x]
where:
cond
is an optional condition code.
datatype
must be either S16 or S32.
Qd, Qn
are the destination vector and the first operand vector, for a quadword operation.
Dd, Dn
are the destination vector and the first operand vector, for a doubleword operation.
Qm or Dm
is the vector holding the second operand, for a by vector operation.
Dm[x]
is the scalar holding the second operand, for a by scalar operation.
Operation
VQRDMULH multiplies corresponding elements in two vectors, doubles the results, and places the
most significant half of the final results in the destination vector.
The second operand can be a scalar instead of a vector.
If any of the results overflow, they are saturated. The sticky QC flag (FPSCR bit[27]) is set if
saturation occurs. Each result is rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQRSHL{cond}.datatype {Qd}, Qm, Qn
VQRSHL{cond}.datatype {Dd}, Dm, Dn
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm, Qn
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dm, Dn
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VQRSHL takes each element in a vector, shifts them by a value from the least significant byte of
the corresponding element of a second vector, and places the results in the destination vector. If
the shift value is positive, the operation is a left shift. Otherwise, it is a rounding right shift.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQRSHR{U}N{cond}.datatype Dd, Qm, #imm
where:
U
if present, indicates that the results are unsigned, although the operands are signed.
Otherwise, the results are the same type as the operands.
cond
is an optional condition code.
datatype
must be one of:
I16, I32, I64
for VQRSHRN or VQRSHRUN. Only a #0 immediate is permitted with these
datatypes.
S16, S32, S64
for VQRSHRN or VQRSHRUN.
U16, U32, U64
for VQRSHRN only.
Dd, Qm
are the destination vector and the operand vector.
imm
is the immediate value specifying the size of the shift, in the range 0 to (size(datatype)
– 1). The ranges are shown in the following table:
Operation
VQRSHR{U}N takes each element in a quadword vector of integers, right shifts them by an
immediate value, and places the results in a doubleword vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQSHL{cond}.datatype {Qd}, Qm, Qn
VQSHL{cond}.datatype {Dd}, Dm, Dn
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm, Qn
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dm, Dn
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VQSHL takes each element in a vector, shifts them by a value from the least significant byte of the
corresponding element of a second vector, and places the results in the destination vector. If the
shift value is positive, the operation is a left shift. Otherwise, it is a truncating right shift.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQSHL{U}{cond}.datatype {Qd}, Qm, #imm
VQSHL{U}{cond}.datatype {Dd}, Dm, #imm
where:
U
only permitted if Q is also present. Indicates that the results are unsigned even though the
operands are signed.
cond
is an optional condition code.
datatype
must be one of :
S8, S16, S32, S64
for VQSHL or VQSHLU.
U8, U16, U32, U64
for VQSHL only.
Qd, Qm
are the destination and operand vectors, for a quadword operation.
Dd, Dm
are the destination and operand vectors, for a doubleword operation.
imm
is the immediate value specifying the size of the shift, in the range 0 to (size(datatype)
– 1). The ranges are shown in the following table:
Table 12-12 Available immediate ranges in VQSHL and VQSHLU (by immediate)
Operation
VQSHL and VQSHLU instructions take each element in a vector of integers, left shift them by an
immediate value, and place the results in the destination vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VQSHR{U}N{cond}.datatype Dd, Qm, #imm
where:
U
if present, indicates that the results are unsigned, although the operands are signed.
Otherwise, the results are the same type as the operands.
cond
is an optional condition code.
datatype
must be one of:
I16, I32, I64
for VQSHRN or VQSHRUN. Only a #0 immediate is permitted with these datatypes.
S16, S32, S64
for VQSHRN or VQSHRUN.
U16, U32, U64
for VQSHRN only.
Dd, Qm
are the destination vector and the operand vector.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Table 12-13 Available immediate ranges in VQSHRN and VQSHRUN (by immediate)
Operation
VQSHR{U}N takes each element in a quadword vector of integers, right shifts them by an
immediate value, and places the results in a doubleword vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.114 VQSUB
Vector Saturating Subtract.
Syntax
VQSUB{cond}.datatype {Qd}, Qn, Qm
VQSUB{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VQSUB subtracts the elements of one vector from the corresponding elements of another vector,
and places the results in the destination vector.
The sticky QC flag (FPSCR bit[27]) is set if saturation occurs.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.115 VRADDHN
Vector Rounding Add and Narrow, selecting High half.
Syntax
VRADDHN{cond}.datatype Dd, Qn, Qm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector.
Operation
VRADDHN adds corresponding elements in two quadword vectors, selects the most significant
halves of the results, and places the final results in the destination doubleword vector. Results are
rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.116 VRECPE
Vector Reciprocal Estimate.
Syntax
VRECPE{cond}.datatype Qd, Qm
VRECPE{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be either U32 or F32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VRECPE finds an approximate reciprocal of each element in a vector, and places the results in a
second vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.117 VRECPS
Vector Reciprocal Step.
Syntax
VRECPS{cond}.F32 {Qd}, Qn, Qm
VRECPS{cond}.F32 {Dd}, Dn, Dm
where:
cond
is an optional condition code.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VRECPS multiplies the elements of one vector by the corresponding elements of another vector,
subtracts each of the results from 2, and places the final results into the elements of the destination
vector.
The Newton-Raphson iteration:
xn+1 = xn (2-dxn)
converges to (1/d) if x0 is the result of VRECPE applied to d.
Related references
10.8 Condition codes on page 10-317.
Syntax
VREVn{cond}.size Qd, Qm
VREVn{cond}.size Dd, Dm
where:
n
must be one of 16, 32, or 64.
cond
is an optional condition code.
size
must be one of 8, 16, or 32, and must be less than n.
Qd, Qm
specifies the destination vector and the operand vector, for a quadword operation.
Dd, Dm
specifies the destination vector and the operand vector, for a doubleword operation.
Operation
VREV16 reverses the order of 8-bit elements within each halfword of the vector, and places the
result in the corresponding destination vector.
VREV32 reverses the order of 8-bit or 16-bit elements within each word of the vector, and places
the result in the corresponding destination vector.
VREV64 reverses the order of 8-bit, 16-bit, or 32-bit elements within each doubleword of the
vector, and places the result in the corresponding destination vector.
Related references
10.8 Condition codes on page 10-317.
12.119 VRHADD
Vector Rounding Halving Add.
Syntax
VRHADD{cond}.datatype {Qd}, Qn, Qm
VRHADD{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VRHADD adds corresponding elements in two vectors, shifts each result right one bit, and places
the results in the destination vector. Results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VRSHL{cond}.datatype {Qd}, Qm, Qn
VRSHL{cond}.datatype {Dd}, Dm, Dn
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm, Qn
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dm, Dn
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VRSHL takes each element in a vector, shifts them by a value from the least significant byte of the
corresponding element of a second vector, and places the results in the destination vector. If the
shift value is positive, the operation is a left shift. Otherwise, it is a rounding right shift.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VRSHR{cond}.datatype {Qd}, Qm, #imm
VRSHR{cond}.datatype {Dd}, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift, in the range 0 to
(size(datatype)). The ranges are shown in the following table:
Operation
VRSHR takes each element in a vector, right shifts them by an immediate value, and places the
results in the destination vector. The results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.70 VMOV (register) on page 12-671.
10.8 Condition codes on page 10-317.
Syntax
VRSHRN{cond}.datatype Dd, Qm, #imm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qm
are the destination vector and the operand vector.
imm
is the immediate value specifying the size of the shift, in the range 0 to
(size(datatype)/2). The ranges are shown in the following table:
Operation
VRSHRN takes each element in a quadword vector, right shifts them by an immediate value, and
places the results in a doubleword vector. The results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.75 VMOVN on page 12-676.
10.8 Condition codes on page 10-317.
12.123 VRSQRTE
Vector Reciprocal Square Root Estimate.
Syntax
VRSQRTE{cond}.datatype Qd, Qm
VRSQRTE{cond}.datatype Dd, Dm
where:
cond
is an optional condition code.
datatype
must be either U32 or F32.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
Operation
VRSQRTE finds an approximate reciprocal square root of each element in a vector, and places the
results in a second vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.124 VRSQRTS
Vector Reciprocal Square Root Step.
Syntax
VRSQRTS{cond}.F32 {Qd}, Qn, Qm
VRSQRTS{cond}.F32 {Dd}, Dn, Dm
where:
cond
is an optional condition code.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VRSQRTS multiplies the elements of one vector by the corresponding elements of another vector,
subtracts each of the results from three, divides these results by two, and places the final results
into the elements of the destination vector.
The Newton-Raphson iteration:
xn+1 = xn (3-dxn2)/2
converges to (1/√d) if x0 is the result of VRSQRTE applied to d.
Related references
10.8 Condition codes on page 10-317.
Syntax
VRSRA{cond}.datatype {Qd}, Qm, #imm
VRSRA{cond}.datatype {Dd}, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift, in the range 1 to
(size(datatype)). The ranges are shown in the following table:
Operation
VRSRA takes each element in a vector, right shifts them by an immediate value, and accumulates
the results into the destination vector. The results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.126 VRSUBHN
Vector Rounding Subtract and Narrow, selecting High half.
Syntax
VRSUBHN{cond}.datatype Dd, Qn, Qm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector.
Operation
VRSUBHN subtracts the elements of one quadword vector from the corresponding elements of
another quadword vector, selects the most significant halves of the results, and places the final
results in the destination doubleword vector. Results are rounded.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSHL{cond}.datatype {Qd}, Qm, #imm
VSHL{cond}.datatype {Dd}, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, or I64.
Qd, Qm
are the destination and operand vectors, for a quadword operation.
Dd, Dm
are the destination and operand vectors, for a doubleword operation.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Operation
VSHL takes each element in a vector of integers, left shifts them by an immediate value, and places
the results in the destination vector.
Bits shifted out of the left of each element are lost.
The following figure shows the operation of VSHL with two elements and a shift value of one. The
least significant bit in each element in the destination vector is set to zero.
Element 1 Element 0
Qm
... ...
Qd 0 0
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSHL{cond}.datatype {Qd}, Qm, Qn
VSHL{cond}.datatype {Dd}, Dm, Dn
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm, Qn
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Dd, Dm, Dn
are the destination vector, the first operand vector, and the second operand vector, for a
doubleword operation.
Operation
VSHL takes each element in a vector, shifts them by the value from the least significant byte of the
corresponding element of a second vector, and places the results in the destination vector. If the
shift value is positive, the operation is a left shift. Otherwise, it is a truncating right shift.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSHLL{cond}.datatype Qd, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Dm
are the destination and operand vectors, for a long operation.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Operation
VSHLL takes each element in a vector of integers, left shifts them by an immediate value, and
places the results in the destination vector. Values are sign or zero extended.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSHR{cond}.datatype {Qd}, Qm, #imm
VSHR{cond}.datatype {Dd}, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Operation
VSHR takes each element in a vector, right shifts them by an immediate value, and places the
results in the destination vector. The results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.70 VMOV (register) on page 12-671.
10.8 Condition codes on page 10-317.
Syntax
VSHRN{cond}.datatype Dd, Qm, #imm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qm
are the destination vector and the operand vector.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Operation
VSHRN takes each element in a quadword vector, right shifts them by an immediate value, and
places the results in a doubleword vector. The results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
12.75 VMOVN on page 12-676.
10.8 Condition codes on page 10-317.
12.132 VSLI
Vector Shift Left and Insert.
Syntax
VSLI{cond}.size {Qd}, Qm, #imm
VSLI{cond}.size {Dd}, Dm, #imm
where:
cond
is an optional condition code.
size
must be one of 8, 16, 32, or 64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift, in the range 0 to (size – 1).
Operation
VSLI takes each element in a vector, left shifts them by an immediate value, and inserts the results
in the destination vector. Bits shifted out of the left of each element are lost. The following figure
shows the operation of VSLI with two elements and a shift value of one. The least significant bit
in each element in the destination vector is unchanged.
Element 1 Element 0
Qm
... ...
Qd
Unchanged Unchanged
bit bit
Related references
10.8 Condition codes on page 10-317.
12.133 VSQRT
Floating-point square root.
Syntax
VSQRT{cond}.F32 Sd, Sm
VSQRT{cond}.F64 Dd, Dm
where:
cond
is an optional condition code.
Sd, Sm
are the single-precision registers for the result and operand.
Dd, Dm
are the double-precision registers for the result and operand.
Operation
The VSQRT instruction takes the square root of the contents of Sm or Dm, and places the result in
Sd or Dd.
Floating-point exceptions
VSQRT instructions can produce Invalid Operation or Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSRA{cond}.datatype {Qd}, Qm, #imm
VSRA{cond}.datatype {Dd}, Dm, #imm
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, S64, U8, U16, U32, or U64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift. The ranges are shown in the
following table:
Operation
VSRA takes each element in a vector, right shifts them by an immediate value, and accumulates the
results into the destination vector. The results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.135 VSRI
Vector Shift Right and Insert.
Syntax
VSRI{cond}.size {Qd}, Qm, #imm
VSRI{cond}.size {Dd}, Dm, #imm
where:
cond
is an optional condition code.
size
must be one of 8, 16, 32, or 64.
Qd, Qm
are the destination vector and the operand vector, for a quadword operation.
Dd, Dm
are the destination vector and the operand vector, for a doubleword operation.
imm
is the immediate value specifying the size of the shift, in the range 1 to size.
Operation
VSRI takes each element in a vector, right shifts them by an immediate value, and inserts the
results in the destination vector. Bits shifted out of the right of each element are lost. The
following figure shows the operation of VSRI with a single element and a shift value of two. The
two most significant bits in the destination vector are unchanged.
Element 0
Dm
... ...
Dd
Unchanged
bits
Related references
10.8 Condition codes on page 10-317.
12.136 VSTM
Extension register store multiple.
Syntax
VSTMmode{cond} Rn{!}, Registers
where:
mode
must be one of:
IA
meaning Increment address After each transfer. IA is the default, and can be
omitted.
DB
meaning Decrement address Before each transfer.
EA
meaning Empty Ascending stack operation. This is the same as IA for stores.
FD
meaning Full Descending stack operation. This is the same as DB for stores.
cond
is an optional condition code.
Rn
is the ARM register holding the base address for the transfer.
!
is optional. ! specifies that the updated base address must be written back to Rn. If ! is
not specified, mode must be IA.
Registers
is a list of consecutive extension registers enclosed in braces, { and }. The list can be
comma-separated, or in range format. There must be at least one register in the list.
You can specify S, D, or Q registers, but they must not be mixed. The number of registers
must not exceed 16 D registers, or 8 Q registers. If Q registers are specified, on
disassembly they are shown as D registers.
Note
VPUSH Registers is equivalent to VSTMDB sp!, Registers.
You can use either form of this instruction. They both disassemble to VPUSH.
Related concepts
4.15 Stack implementation using LDM and STM on page 4-86.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSTn{cond}.datatype list, [Rn{@align}]{!}
VSTn{cond}.datatype list, [Rn{@align}], Rm
where:
n
must be one of 1, 2, 3, or 4.
cond
is an optional condition code.
datatype
see the following table for options.
list
specifies the NEON register list. See the following table for options.
Rn
is the ARM register containing the base address. Rn cannot be PC.
align
specifies an optional alignment. See the following table for options.
!
if ! is present, Rn is updated to (Rn + the number of bytes transferred by the instruction).
The update occurs after all the stores have taken place.
Rm
is an ARM register containing an offset from the base address. If Rm is present, the
instruction updates Rn to (Rn + Rm) after using the address to access memory. Rm cannot
be SP or PC.
Operation
VSTn stores multiple n-element structures to memory from one or more NEON registers, with
interleaving (unless n == 1). Every element of each register is stored.
Table 12-26 Permitted combinations of parameters for VSTn (multiple n-element structures)
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.50 VLDn (single n-element structure to one lane) on page 12-648.
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
10.8 Condition codes on page 10-317.
Syntax
VSTn{cond}.datatype list, [Rn{@align}]{!}
VSTn{cond}.datatype list, [Rn{@align}], Rm
where:
n
must be one of 1, 2, 3, or 4.
cond
is an optional condition code.
datatype
see the following table.
list
specifies the NEON register list. See the following table for options.
Rn
is the ARM register containing the base address. Rn cannot be PC.
align
specifies an optional alignment. See the following table for options.
!
if ! is present, Rn is updated to (Rn + the number of bytes transferred by the instruction).
The update occurs after all the stores have taken place.
Rm
is an ARM register containing an offset from the base address. If Rm is present, the
instruction updates Rn to (Rn + Rm) after using the address to access memory. Rm cannot
be SP or PC.
Operation
VSTn stores one n-element structure into memory from one or more NEON registers.
Table 12-27 Permitted combinations of parameters for VSTn (single n-element structure to
one lane)
Table 12-27 Permitted combinations of parameters for VSTn (single n-element structure to one
lane) (continued)
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
12.5 Alignment restrictions in load and store element and structure instructions on page 12-603.
Related references
12.51 VLDn (single n-element structure to all lanes) on page 12-650.
12.52 VLDn (multiple n-element structures) on page 12-652.
10.8 Condition codes on page 10-317.
12.139 VSTR
Extension register store.
Syntax
VSTR{cond}{.size} Fd, [Rn{, #offset}]
VSTR{cond}{.size} Fd, label
where:
cond
is an optional condition code.
size
is an optional data size specifier. Must be 32 if Fd is an S register, or 64 otherwise.
Fd
is the extension register to be saved. For a NEON instruction, it must be a D register. For
a VFP instruction, it can be either a D or S register.
Rn
is the ARM register holding the base address for the transfer.
offset
is an optional numeric expression. It must evaluate to a numeric value at assembly time.
The value must be a multiple of 4, and lie in the range –1020 to +1020. The value is
added to the base address to form the address used for the transfer.
label
is a PC-relative expression.
label must be aligned on a word boundary within ±1KB of the current instruction.
Operation
The VSTR instruction saves the contents of an extension register to memory.
One word is transferred if Fd is an S register (VFP only). Two words are transferred otherwise.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
12.56 VLDR pseudo-instruction on page 12-657.
10.8 Condition codes on page 10-317.
Note
There are also VLDR and VSTR instructions without post-increment and pre-decrement.
Syntax
VSTR{cond}{.size} Fd, [Rn], #offset ; post-increment
VSTR{cond}{.size} Fd, [Rn, #-offset]! ; pre-decrement
where:
cond
is an optional condition code.
size
is an optional data size specifier. Must be 32 if Fd is an S register, or 64 if Fd is a D
register.
Fd
is the extension register to be saved. For a NEON instruction, it must be a doubleword
(Dd) register. For a VFP instruction, it can be either a double precision (Dd) or a single
precision (Sd) register.
Rn
is the ARM register holding the base address for the transfer.
offset
is a numeric expression that must evaluate to a numeric value at assembly time. The
value must be 4 if Fd is an S register, or 8 if Fd is a D register.
Operation
The post-increment instruction increments the base address in the register by the offset value, after
the transfer. The pre-decrement instruction decrements the base address in the register by the
offset value, and then performs the transfer using the new address in the register. This pseudo-
instruction assembles to a VSTM instruction.
Related references
12.139 VSTR on page 12-743.
12.136 VSTM on page 12-738.
10.8 Condition codes on page 10-317.
Syntax
VSUB{cond}.F32 {Sd}, Sn, Sm
VSUB{cond}.F64 {Dd}, Dn, Dm
where:
cond
is an optional condition code.
Sd, Sn, Sm
are the single-precision registers for the result and operands.
Dd, Dn, Dm
are the double-precision registers for the result and operands.
Operation
The VSUB instruction subtracts the value in the second operand register from the value in the first
operand register, and places the result in the destination register.
Floating-point exceptions
The VSUB instruction can produce Invalid Operation, Overflow, or Inexact exceptions.
Related references
10.8 Condition codes on page 10-317.
12.142 VSUB
Vector Subtract.
Syntax
VSUB{cond}.datatype {Qd}, Qn, Qm
VSUB{cond}.datatype {Dd}, Dn, Dm
where:
cond
is an optional condition code.
datatype
must be one of I8, I16, I32, I64, or F32.
Qd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector, for a
quadword operation.
Operation
VSUB subtracts the elements of one vector from the corresponding elements of another vector, and
places the results in the destination vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.143 VSUBHN
Vector Subtract and Narrow, selecting High half.
Syntax
VSUBHN{cond}.datatype Dd, Qn, Qm
where:
cond
is an optional condition code.
datatype
must be one of I16, I32, or I64.
Dd, Qn, Qm
are the destination vector, the first operand vector, and the second operand vector.
Operation
VSUBHN subtracts the elements of one quadword vector from the corresponding elements of
another quadword vector, selects the most significant halves of the results, and places the final
results in the destination doubleword vector. Results are truncated.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
Syntax
VSUBL{cond}.datatype Qd, Dn, Dm ; Long operation
VSUBW{cond}.datatype {Qd}, Qn, Dm ; Wide operation
where:
cond
is an optional condition code.
datatype
must be one of S8, S16, S32, U8, U16, or U32.
Qd, Dn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
long operation.
Qd, Qn, Dm
are the destination vector, the first operand vector, and the second operand vector, for a
wide operation.
Operation
VSUBL subtracts the elements of one doubleword vector from the corresponding elements of
another doubleword vector, and places the results in the destination quadword vector.
VSUBW subtracts the elements of a doubleword vector from the corresponding elements of a
quadword vector, and places the results in the destination quadword vector.
Related concepts
8.10 NEON and VFP data types on page 8-187.
Related references
10.8 Condition codes on page 10-317.
12.145 VSWP
Vector Swap.
Syntax
VSWP{cond}{.datatype} Qd, Qm
VSWP{cond}{.datatype} Dd, Dm
where:
cond
is an optional condition code.
datatype
is an optional datatype. The assembler ignores datatype.
Qd, Qm
specifies the vectors for a quadword operation.
Dd, Dm
specifies the vectors for a doubleword operation.
Operation
VSWP exchanges the contents of two vectors. The vectors can be either doubleword or quadword.
There is no distinction between data types.
Related references
10.8 Condition codes on page 10-317.
Syntax
Vop{cond}.8 Dd, list, Dm
where:
op
must be either TBL or TBX.
cond
is an optional condition code.
Dd
specifies the destination vector.
list
Specifies the vectors containing the table. It must be one of:
• {Dn}.
• {Dn,D(n+1)}.
• {Dn,D(n+1),D(n+2)}.
• {Dn,D(n+1),D(n+2),D(n+3)}.
• {Qn,Q(n+1)}.
All the registers in list must be in the range D0-D31 or Q0-Q15 and must not wrap
around the end of the register bank. For example {D31,D0,D1} is not permitted. If list
contains Q registers, they disassemble to the equivalent D registers.
Dm
specifies the index vector.
Operation
VTBL uses byte indexes in a control vector to look up byte values in a table and generate a new
vector. Indexes out of range return zero.
VTBX works in the same way, except that indexes out of range leave the destination element
unchanged.
Related references
10.8 Condition codes on page 10-317.
12.147 VTRN
Vector Transpose.
Syntax
VTRN{cond}.size Qd, Qm
VTRN{cond}.size Dd, Dm
where:
cond
is an optional condition code.
size
must be one of 8, 16, or 32.
Qd, Qm
specifies the vectors, for a quadword operation.
Dd, Dm
specifies the vectors, for a doubleword operation.
Operation
VTRN treats the elements of its operand vectors as elements of 2 x 2 matrices, and transposes the
matrices. The following figures show examples of the operation of VTRN:
7 6 5 4 3 2 1 0
Dm
Dd
1 0
Dm
Dd
Related references
10.8 Condition codes on page 10-317.
12.148 VTST
Vector Test bits.
Syntax
VTST{cond}.size {Qd}, Qn, Qm
VTST{cond}.size {Dd}, Dn, Dm
where:
cond
is an optional condition code.
size
must be one of 8, 16, or 32.
Qd, Qn, Qm
specifies the destination register, the first operand register, and the second operand
register, for a quadword operation.
Dd, Dn, Dm
specifies the destination register, the first operand register, and the second operand
register, for a doubleword operation.
Operation
VTST takes each element in a vector, and bitwise logical ANDs them with the corresponding
element of a second vector. If the result is not zero, the corresponding element in the destination
vector is set to all ones. Otherwise, it is set to all zeros.
Related references
10.8 Condition codes on page 10-317.
12.149 VUZP
Vector Unzip.
Syntax
VUZP{cond}.size Qd, Qm
VUZP{cond}.size Dd, Dm
where:
cond
is an optional condition code.
size
must be one of 8, 16, or 32.
Qd, Qm
specifies the vectors, for a quadword operation.
Dd, Dm
specifies the vectors, for a doubleword operation.
Note
The following are all the same instruction:
• VZIP.32 Dd, Dm.
• VUZP.32 Dd, Dm.
• VTRN.32 Dd, Dm.
The instruction is disassembled as VTRN.32 Dd, Dm.
Operation
VUZP de-interleaves the elements of two vectors.
De-interleaving is the inverse process of interleaving.
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
Related references
12.147 VTRN on page 12-751.
10.8 Condition codes on page 10-317.
12.150 VZIP
Vector Zip.
Syntax
VZIP{cond}.size Qd, Qm
VZIP{cond}.size Dd, Dm
where:
cond
is an optional condition code.
size
must be one of 8, 16, or 32.
Qd, Qm
specifies the vectors, for a quadword operation.
Dd, Dm
specifies the vectors, for a doubleword operation.
Note
The following are all the same instruction:
• VZIP.32 Dd, Dm.
• VUZP.32 Dd, Dm.
• VTRN.32 Dd, Dm.
The instruction is disassembled as VTRN.32 Dd, Dm.
Operation
VZIP interleaves the elements of two vectors.
Related concepts
12.4 Interleaving provided by load and store element and structure instructions on page 12-602.
Related references
12.147 VTRN on page 12-751.
10.8 Condition codes on page 10-317.
Related concepts
13.3 Frame directives and Wireless MMX Technology on page 13-758.
13.5 Wireless MMX Technology and XScale instructions on page 13-761.
Related references
13.2 WRN and WCN directives to support Wireless MMX Technology on page 13-757.
13.4 Wireless MMX load and store instructions on page 13-759.
Related information
Further reading.
WRN
Defines a name for a specified SIMD Data register, for example:
Avoid conflicting uses of the same register under different names. Do not use any of the
predefined register and coprocessor names.
Related concepts
13.1 About Wireless MMX Technology instructions on page 13-756.
Related concepts
13.1 About Wireless MMX Technology instructions on page 13-756.
Syntax
op<type>{cond} wRd, [Rn, #{-}offset]{!}
op<type>{cond} wRd, [Rn] {, #{-}offset}
opW{cond} wRd, label
opW wCd, [Rn, #{-}offset]{!}
opW wCd, [Rn] {, #{-}offset}
opD {cond} wRd,label
opD wRd, [Rn, {-}Rm {, LSL #imm4}]{!} ; MMX2 only
opD wRd, [Rn], {-}Rm {, LSL #imm4} ; MMX2 only
where:
op
can be either:
WLDR
Load Wireless MMX Register.
WSTR
Store Wireless MMX Register.
<type>
can be any one of:
B
Byte.
H
Halfword.
W
Word.
D
Doubleword.
cond
is an optional condition code.
wRd
is the Wireless MMX SIMD data register to load or save.
wCd
is the Wireless MMX Status and Control register to load or save.
Rn
is the register on which the memory address is based.
offset
is an immediate offset. If offset is omitted, the instruction is a zero offset instruction.
!
is an optional suffix. If ! is present, the instruction is a pre-indexed instruction.
label
is a PC-relative expression.
label must be within ± 1020 bytes of the current instruction.
Rm
is a register containing a value to be used as the offset. Rm must not be PC.
imm4
contains the number of bits to shift Rm left, in the range 0-15.
Be aware that:
• The assembler cannot load byte and halfword literals. These produce a downgradable error. If
downgraded, the instruction is converted to a WLDRW and a 32-bit literal is generated. This is
the same as a byte literal load, but uses a 32-bit word instead.
• If the literal to be loaded is zero, and the destination is a SIMD Data register, the assembler
converts the instruction to a WZERO.
• Doubleword loads must be 8-byte aligned.
Related concepts
13.1 About Wireless MMX Technology instructions on page 13-756.
Related concepts
7.5 Register-relative and PC-relative expressions on page 7-149.
Related references
2.13 Predeclared XScale register names on page 2-48.
10.53 MIA, MIAPH, and MIAxy on page 10-398.
10.50 MAR on page 10-395.
14.3 About frame directives on page 14-770.
14.29 FRAME PUSH on page 14-801.
14.27 FRAME ADDRESS on page 14-799.
14.32 FRAME RETURN ADDRESS on page 14-804.
10.8 Condition codes on page 10-317.
Mnemonic Example
TANDC
TANDCB r15
TBCST
TBCSTB wr15, r1
TEXTRC
TEXTRCB r15, #0
TEXTRM
TEXTRMUBCS r3, wr7, #7
TINSR
TINSRB wr6, r11, #0
TMOVMSK
TMOVMSKBNE r14, wr15
TORC
TORCB r15
WACC
WACCBGE wr1, wr2
WADD
WADDBGE wr1, wr2, wr13
WALIGNI, WALIGNR
WALIGNI wr7, wr6, wr5,#3
WALIGNR0 wr4, wr8, wr12
WAND, WANDN
WAND wr1, wr2, wr3
WANDN wr5, wr5, wr9
Mnemonic Example
WAVG2
WAVG2B wr3, wr6, wr9
WAVG2BR wr4, wr7, wr10
WCMPEQ
WCMPEQB wr0, wr4, wr2
WCMPGT
WCMPGTUB wr0, wr4, wr2
WLDR
WLDRB wr1, [r2, #0]
WMAC
WMACU wr3, wr4, wr5
WMADD
WMADDU wr3, wr4, wr5
WMAX, WMIN
WMAXUB wr0, wr4, wr2
WMINSB wr0, wr4, wr2
WMUL
WMULUL wr4, wr2, wr3
WOR
WOR wr3, wr1, wr4
WPACK
WPACKHUS wr2, wr7, wr1
WROR
WRORH wr3, wr1, wr4
WSAD
WSADB wr3, wr5, wr8
WSHUFH
WSHUFH wr8, wr15, #17
WSLL, WSRL
WSLLH wr3, wr1, wr4
WSRLHG wr3, wr1, wcgr0
WSRA
WSRAH wr3, wr1, wr4
WSRAHG wr3, wr1, wcgr0
Mnemonic Example
WSTR
WSTRB wr1, [r2, #0]
WSTRW wc1, [r2, #0]
WSUB
WSUBBGE wr1, wr2, wr13
WUNPCKEH, WUNPCKEL
WUNPCKEHUB wr0, wr4
WUNPCKELSB wr0, wr4
WUNPCKIH, WUNPCKIL
WUNPCKIHB wr0, wr4, wr2
WUNPCKILH wr1, wr5, wr3
WXOR
WXOR wr3, wr1, wr4
Related concepts
13.1 About Wireless MMX Technology instructions on page 13-756.
Related references
13.7 Wireless MMX pseudo-instructions on page 13-765.
Related information
Further reading.
TMCRR Moves the contents of two source registers, RnLo and RnHi, to destination
register, wRd. Do not use R15 for either RnLo or RnHi. Maps onto the ARM TMCRR wr4, r5, r6
MCRR coprocessor instruction.
TMRC Moves the contents of Control register, wCn, to destination register, Rd. Do not
use R15 for Rd. Maps onto the ARM MRC coprocessor instruction. TMRC r1, wc2
TMRRC Moves the contents of source register, wRn, to two destination registers, RdLo and
RdHi. Do not use R15 for either destination register. RdLo and RdHi must be TMRRC r1, r0, wr2
distinct registers. Maps onto the ARM MRRC coprocessor instruction.
WMOV Moves the contents of source register, wRn, to destination register, wRd. This
instruction is a form of WOR. WMOV wr1, wr8
Related references
10.51 MCR and MCR2 on page 10-396.
10.52 MCRR and MCRR2 on page 10-397.
10.60 MRC and MRC2 on page 10-407.
10.61 MRRC and MRRC2 on page 10-408.
13.6 Wireless MMX instructions on page 13-762.
Describes the directives that are provided by the ARM assembler, armasm.
Note
None of these directives are available in the inline assemblers in the ARM C and C++ compilers.
Nesting directives
The following structures can be nested to a total depth of 256:
• MACRO definitions.
• WHILE...WEND loops.
• IF...ELSE...ENDIF conditional structures.
• INCLUDE file inclusions.
The limit applies to all structures taken together, regardless of how they are nested. The limit is
not 256 of each type of structure.
Related references
14.50 MACRO and MEND on page 14-825.
14.52 MEXIT on page 14-829.
14.43 IF, ELSE, ENDIF, and ELIF on page 14-816.
14.65 WHILE and WEND on page 14-845.
Related references
14.27 FRAME ADDRESS on page 14-799.
14.28 FRAME POP on page 14-800.
14.29 FRAME PUSH on page 14-801.
14.30 FRAME REGISTER on page 14-802.
14.31 FRAME RESTORE on page 14-803.
14.32 FRAME RETURN ADDRESS on page 14-804.
14.33 FRAME SAVE on page 14-805.
14.34 FRAME STATE REMEMBER on page 14-806.
14.35 FRAME STATE RESTORE on page 14-807.
14.36 FRAME UNWIND ON on page 14-808.
14.37 FRAME UNWIND OFF on page 14-809.
14.38 FUNCTION or PROC on page 14-810.
14.39 ENDFUNC or ENDP on page 14-812.
14.4 ALIAS
The ALIAS directive creates an alias for a symbol.
Syntax
ALIAS name, aliasname
where:
name
is the name of the symbol to create an alias for
aliasname
is the name of the alias to be created.
Usage
The symbol name must already be defined in the source file before creating an alias for it.
Properties of name set by the EXPORT directive are not inherited by aliasname, so you must use
EXPORT on aliasname if you want to make the alias available outside the current source file.
Apart from the properties set by the EXPORT directive, name and aliasname are identical.
Example
baz
bar PROC
BX lr
ENDP
ALIAS bar,foo ; foo is an alias for bar
EXPORT bar
EXPORT foo ; foo and bar have identical properties
; because foo was created using ALIAS
EXPORT baz ; baz and bar are not identical
; because the size field of baz is not set
Incorrect example
EXPORT bar
IMPORT car
ALIAS bar,foo ; ERROR - bar is not defined yet
ALIAS car,boo ; ERROR - car is external
bar PROC
BX lr
ENDP
Related references
14.25 EXPORT or GLOBAL on page 14-796.
14.5 ALIGN
The ALIGN directive aligns the current location to a specified boundary by padding with zeros or
NOP instructions.
Syntax
ALIGN {expr{,offset{,pad{,padsize}}}}
where:
expr
is a numeric expression evaluating to any power of 2 from 20 to 231
offset
can be any numeric expression
pad
can be any numeric expression
padsize
can be 1, 2 or 4.
Operation
The current location is aligned to the next lowest address of the form:
offset + n * expr
n is any integer which the assembler selects to minimise padding.
If expr is not specified, ALIGN sets the current location to the next word (four byte) boundary.
The unused space between the previous and the new current location are filled with:
• Copies of pad, if pad is specified.
• NOP instructions, if all the following conditions are satisfied:
— pad is not specified.
— The ALIGN directive follows ARM or Thumb instructions.
— The current section has the CODEALIGN attribute set on the AREA directive.
• Zeros otherwise.
pad is treated as a byte, halfword, or word, according to the value of padsize. If padsize is not
specified, pad defaults to bytes in data sections, halfwords in Thumb code, or words in ARM
code.
Usage
Use ALIGN to ensure that your data and code is aligned to appropriate boundaries. This is
typically required in the following circumstances:
• The ADR Thumb pseudo-instruction can only load addresses that are word aligned, but a label
within Thumb code might not be word aligned. Use ALIGN 4 to ensure four-byte alignment of
an address within Thumb code.
• Use ALIGN to take advantage of caches on some ARM processors. For example, the
ARM940T has a cache with 16-byte lines. Use ALIGN 16 to align function entries on 16-byte
boundaries and maximize the efficiency of the cache.
• LDRD and STRD doubleword data transfers must be eight-byte aligned. Use ALIGN 8 before
memory allocation directives such as DCQ if the data is to be accessed using LDRD or STRD.
• A label on a line by itself can be arbitrarily aligned. Following ARM code is word-aligned
(Thumb code is halfword aligned). The label therefore does not address the code correctly. Use
ALIGN 4 (or ALIGN 2 for Thumb) before the label.
Alignment is relative to the start of the ELF section where the routine is located. The section must
be aligned to the same, or coarser, boundaries. The ALIGN attribute on the AREA directive is
specified differently.
Examples
In the following example, the ALIGN directive tells the assembler that the next instruction is word
aligned and offset by 3 bytes. The 3 byte offset is counted from the previous word aligned address,
resulting in the second DCB placed in the last byte of the same word and 2 bytes of padding are to
be added.
In the following example, the ALIGN directive tells the assembler that the next instruction is word
aligned and offset by 2 bytes. Here, the 2 byte offset is counted from the next word aligned
address, so the value n is set to 1 (n=0 clashes with the third DCB). This time three bytes of
padding are to be added.
In the following example, the DCB directive makes the PC misaligned. The ALIGN directive
ensures that the label subroutine1 and the following instruction are word aligned.
Related references
14.6 AREA on page 14-774.
14.6 AREA
The AREA directive instructs the assembler to assemble a new code or data section.
Sections are independent, named, indivisible chunks of code or data that are manipulated by the
linker.
Syntax
AREA sectionname{,attr}{,attr}...
where:
sectionname
is the name to give to the section.
You can choose any name for your sections. However, names starting with a non-
alphabetic character must be enclosed in bars or a missing section name error is
generated. For example, |1_DataArea|.
Certain names are conventional. For example, |.text| is used for code sections
produced by the C compiler, or for code sections otherwise associated with the C library.
attr
are one or more comma-delimited section attributes. Valid attributes are:
ALIGN=expression
By default, ELF sections are aligned on a four-byte boundary. expression can
have any integer value from 0 to 31. The section is aligned on a 2expression-byte
boundary. For example, if expression is 10, the section is aligned on a 1KB
boundary.
This is not the same as the way that the ALIGN directive is specified.
Note
Do not use ALIGN=0 or ALIGN=1 for ARM code sections.
Do not use ALIGN=0 for Thumb code sections.
ASSOC=section
section specifies an associated ELF section. sectionname must be included
in any link that includes section
CODE
Contains machine instructions. READONLY is the default.
CODEALIGN
Causes the assembler to insert NOP instructions when the ALIGN directive is used
after ARM or Thumb instructions within the section, unless the ALIGN directive
specifies a different padding. CODEALIGN is the default for execute-only
sections.
COMDEF
Is a common section definition. This ELF section can contain code or data. It
must be identical to any other section of the same name in other source files.
Identical ELF sections with the same name are overlaid in the same section of
memory by the linker. If any are different, the linker generates a warning and
does not overlay the sections.
COMGROUP=symbol_name
Is the signature that makes the AREA part of the named ELF section group. See
the GROUP=symbol_name for more information. The COMGROUP attribute
marks the ELF section group with the GRP_COMDAT flag.
COMMON
Is a common data section. You must not define any code or data in it. It is
initialized to zeros by the linker. All common sections with the same name are
overlaid in the same section of memory by the linker. They do not all have to be
the same size. The linker allocates as much space as is required by the largest
common section of each name.
DATA
Contains data, not instructions. READWRITE is the default.
EXECONLY
Indicates that the section is execute-only. Execute-only sections must also have
the CODE attribute, and must not have any of the following attributes:
• READONLY.
• READWRITE.
• DATA.
• ZEROALIGN.
The assembler faults if any of the following occur in an execute-only section:
• Explicit data definitions, for example DCD and DCB.
• Implicit data definitions, for example LDR r0, =0xaabbccdd.
• Literal pool directives, for example LTORG, if there is literal data to be
emitted.
• INCBIN or SPACE directives.
• ALIGN directives, if the required alignment cannot be accomplished by
padding with NOP instructions. The assembler implicitly applies the
CODEALIGN attribute to sections with the EXECONLY attribute.
FINI_ARRAY
Sets the ELF type of the current area to SHT_FINI_ARRAY.
GROUP=symbol_name
Is the signature that makes the AREA part of the named ELF section group. It
must be defined by the source file, or a file included by the source file. All
AREAS with the same symbol_name signature are part of the same group.
Sections within a group are kept or discarded together.
INIT_ARRAY
Sets the ELF type of the current area to SHT_INIT_ARRAY.
LINKORDER=section
Specifies a relative location for the current section in the image. It ensures that
the order of all the sections with the LINKORDER attribute, with respect to each
other, is the same as the order of the corresponding named sections in the
image.
MERGE=n
Indicates that the linker can merge the current section with other sections with
the MERGE=n attribute. n is the size of the elements in the section, for example
n is 1 for characters. You must not assume that the section is merged, because
the attribute does not force the linker to merge the sections.
NOALLOC
Indicates that no memory on the target system is allocated to this area.
NOINIT
Indicates that the data section is uninitialized, or initialized to zero. It contains
only space reservation directives SPACE or DCB, DCD, DCDU, DCQ, DCQU, DCW, or
DCWU with initialized values of zero. You can decide at link time whether an area
is uninitialized or zero initialized.
PREINIT_ARRAY
Sets the ELF type of the current area to SHT_PREINIT_ARRAY.
READONLY
Indicates that this section must not be written to. This is the default for Code
areas.
READWRITE
Indicates that this section can be read from and written to. This is the default for
Data areas.
SECFLAGS=n
Adds one or more ELF flags, denoted by n, to the current section.
SECTYPE=n
Sets the ELF type of the current section to n.
STRINGS
Adds the SHF_STRINGS flag to the current section. To use the STRINGS
attribute, you must also use the MERGE=1 attribute. The contents of the section
must be strings that are nul-terminated using the DCB directive.
ZEROALIGN
Causes the assembler to insert zeros when the ALIGN directive is used after
ARM or Thumb instructions within the section, unless the ALIGN directive
specifies a different padding. ZEROALIGN is the default for sections that are not
execute-only.
Usage
Use the AREA directive to subdivide your source file into ELF sections. You can use the same
name in more than one AREA directive. All areas with the same name are placed in the same ELF
section. Only the attributes of the first AREA directive of a particular name are applied.
In general, ARM recommends that you use separate ELF sections for code and data. However,
you can put data in code sections. Large programs can usually be conveniently divided into
several code sections. Large independent data sets are also usually best placed in separate sections.
The scope of numeric local labels is defined by AREA directives, optionally subdivided by ROUT
directives.
There must be at least one AREA directive for an assembly.
Note
The assembler emits R_ARM_TARGET1 relocations for the DCD and DCDU directives if the directive
uses PC-relative expressions and is in any of the PREINIT_ARRAY, FINI_ARRAY, or
INIT_ARRAY ELF sections. You can override the relocation using the RELOC directive after each
DCD or DCDU directive. If this relocation is used, read-write sections might become read-only
sections at link time if the platform ABI permits this.
Example
The following example defines a read-only code section named Example:
Related concepts
3.3 ELF sections and the AREA directive on page 3-61.
Related references
14.5 ALIGN on page 14-772.
14.56 RELOC on page 14-835.
14.15 DCD and DCDU on page 14-786.
Related information
Execute-only memory.
Building applications for execute-only memory.
Information about image structure and generation.
Syntax
ARM
THUMB
THUMBX
CODE16
CODE32
Usage
In files that contain code using different instruction sets:
• ARM must precede any ARM code. CODE32 is a synonym for ARM.
• THUMB must precede Thumb code written in UAL syntax.
• THUMBX must precede ThumbEE code written in UAL syntax.
• CODE16 must precede Thumb code written in pre-UAL syntax.
These directives do not assemble to any instructions. They also do not change the state. They only
instruct the assembler to assemble ARM, Thumb, or ThumbEE instructions as appropriate, and
insert padding if necessary.
Example
This example shows how you can use ARM and THUMB directives to switch state and assemble both
ARM and Thumb instructions in a single area.
14.8 ASSERT
The ASSERT directive generates an error message during assembly if a given assertion is false.
Syntax
ASSERT logical-expression
where:
logical-expression
is an assertion that can evaluate to either {TRUE} or {FALSE}.
Usage
Use ASSERT to ensure that any necessary condition is met during assembly.
If the assertion is false an error message is generated and assembly fails.
Example
Related references
14.46 INFO on page 14-821.
14.9 ATTR
The ATTR set directives set values for the ABI build attributes. The ATTR scope directives specify
the scope for which the set value applies to.
Syntax
ATTR FILESCOPE
ATTR SCOPE name
ATTR settype tagid, value
where:
name
is a section name or symbol name.
settype
can be any of:
• SETVALUE.
• SETSTRING.
• SETCOMPATIBLEWITHVALUE.
• SETCOMPATIBLEWITHSTRING.
tagid
is an attribute tag name (or its numerical value) defined in the ABI for the ARM
Architecture.
value
depends on settype:
• is a 32-bit integer value when settype is SETVALUE or
SETCOMPATIBLEWITHVALUE.
• is a nul-terminated string when settype is SETSTRING or
SETCOMPATIBLEWITHSTRING.
Usage
The ATTR set directives following the ATTR FILESCOPE directive apply to the entire object file.
The ATTR set directives following the ATTR SCOPE name directive apply only to the named
section or symbol.
For tags that expect an integer, you must use SETVALUE or SETCOMPATIBLEWITHVALUE. For
tags that expect a string, you must use SETSTRING or SETCOMPATIBLEWITHSTRING.
Use SETCOMPATIBLEWITHVALUE and SETCOMPATIBLEWITHSTRING to set tag values which the
object file is also compatible with.
Examples
Related information
Addenda to, and Errata in, the ABI for the ARM Architecture.
14.10 CN
The CN directive defines a name for a coprocessor register.
Syntax
name CN expr
where:
name
is the name to be defined for the coprocessor register. name cannot be the same as any of
the predefined names.
expr
evaluates to a coprocessor register number from 0 to 15.
Usage
Use CN to allocate convenient names to registers, to help you remember what you use each
register for.
Note
Avoid conflicting uses of the same register under different names.
Example
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
14.11 COMMON
The COMMON directive allocates a block of memory of the defined size, at the specified symbol.
You specify how the memory is aligned. If alignment is omitted, the default alignment is 4. If size
is omitted, the default size is 0.
You can access this memory as you would any other memory, but no space is allocated in object
files.
Syntax
COMMON symbol{,size{,alignment}} {[attr]}
where:
symbol
is the symbol name. The symbol name is case-sensitive.
size
is the number of bytes to reserve.
alignment
is the alignment.
attr
can be any one of:
DYNAMIC
sets the ELF symbol visibility to STV_DEFAULT.
PROTECTED
sets the ELF symbol visibility to STV_PROTECTED.
HIDDEN
sets the ELF symbol visibility to STV_HIDDEN.
INTERNAL
sets the ELF symbol visibility to STV_INTERNAL.
Usage
The linker allocates the required space as zero initialized memory during the link stage. You
cannot define, IMPORT or EXTERN a symbol that has already been created by the COMMON
directive. In the same way, if a symbol has already been defined or used with the IMPORT or
EXTERN directive, you cannot use the same symbol for the COMMON directive.
Example
Incorrect examples
COMMON foo,4,4
COMMON bar,4,4
foo DCD 0 ; cannot define label with same name as COMMON
IMPORT bar ; cannot import label with same name as COMMON
14.12 CP
The CP directive defines a name for a specified coprocessor.
The coprocessor number must be within the range 0 to 15.
Syntax
name CP expr
where:
name
is the name to be assigned to the coprocessor. name cannot be the same as any of the
predefined names.
expr
evaluates to a coprocessor number from 0 to 15.
Usage
Use CP to allocate convenient names to coprocessors, to help you to remember what you use each
one for.
Note
Avoid conflicting uses of the same coprocessor under different names.
Example
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
14.13 DATA
The DATA directive is no longer required. It is ignored by the assembler.
14.14 DCB
The DCB directive allocates one or more bytes of memory, and defines the initial runtime contents
of the memory.
= is a synonym for DCB.
Syntax
{label} DCB expr{,expr}...
where:
expr
is either:
• A numeric expression that evaluates to an integer in the range –128 to 255.
• A quoted string. The characters of the string are loaded into consecutive bytes of
store.
Usage
If DCB is followed by an instruction, use an ALIGN directive to ensure that the instruction is
aligned.
Example
Unlike C strings, ARM assembler strings are not nul-terminated. You can construct a nul-
terminated C string using DCB as follows:
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.15 DCD and DCDU on page 14-786.
14.20 DCQ and DCQU on page 14-791.
14.21 DCW and DCWU on page 14-792.
14.63 SPACE or FILL on page 14-843.
14.5 ALIGN on page 14-772.
Syntax
{label} DCD{U} expr{,expr}
where:
expr
is either:
• A numeric expression.
• A PC-relative expression.
Usage
DCD inserts up to three bytes of padding before the first defined word, if necessary, to achieve
four-byte alignment.
Use DCDU if you do not require alignment.
Examples
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.14 DCB on page 14-785.
14.20 DCQ and DCQU on page 14-791.
14.21 DCW and DCWU on page 14-792.
14.63 SPACE or FILL on page 14-843.
14.19 DCI on page 14-790.
14.16 DCDO
The DCDO directive allocates one or more words of memory, aligned on four-byte boundaries, and
defines the initial runtime contents of the memory as an offset from the static base register, sb
(R9).
Syntax
{label} DCDO expr{,expr}...
where:
expr
is a register-relative expression or label. The base register must be sb.
Usage
Use DCDO to allocate space in memory for static base register relative relocatable addresses.
Example
IMPORT externsym
DCDO externsym ; 32-bit word relocated by offset of
; externsym from base of SB section.
Syntax
{label} DCFD{U} fpliteral{,fpliteral}...
where:
fpliteral
is a double-precision floating-point literal.
Usage
The assembler inserts up to three bytes of padding before the first defined number, if necessary, to
achieve four-byte alignment.
Use DCFDU if you do not require alignment.
The word order used when converting fpliteral to internal form is controlled by the floating-
point architecture selected. You cannot use DCFD or DCFDU if you select the --fpu none option.
The range for double-precision numbers is:
• Maximum 1.79769313486231571e+308.
• Minimum 2.22507385850720138e–308.
Examples
DCFD 1E308,-4E-100
DCFDU 10000,-.1,3.1E26
Related references
14.18 DCFS and DCFSU on page 14-789.
7.16 Syntax of floating-point literals on page 7-160.
Syntax
{label} DCFS{U} fpliteral{,fpliteral}...
where:
fpliteral
is a single-precision floating-point literal.
Usage
DCFS inserts up to three bytes of padding before the first defined number, if necessary to achieve
four-byte alignment.
Use DCFSU if you do not require alignment.
The range for single-precision values is:
• Maximum 3.40282347e+38.
• Minimum 1.17549435e–38.
Examples
DCFS 1E3,-4E-9
DCFSU 1.0,-.1,3.1E6
Related references
14.17 DCFD and DCFDU on page 14-788.
7.16 Syntax of floating-point literals on page 7-160.
14.19 DCI
The DCI directive allocates two or four-byte aligned memory and defines the initial runtime
contents of the memory.
In ARM code, it allocates one or more words of memory, aligned on four-byte boundaries.
In Thumb code, it allocates one or more halfwords of memory, aligned on two-byte boundaries.
Syntax
{label} DCI{.W} expr{,expr}
where:
expr
is a numeric expression.
.W
if present, indicates that four bytes must be inserted in Thumb code.
Usage
The DCI directive is very like the DCD or DCW directives, but the location is marked as code
instead of data. Use DCI when writing macros for new instructions not supported by the version of
the assembler you are using.
In ARM code, DCI inserts up to three bytes of padding before the first defined word, if necessary,
to achieve four-byte alignment. In Thumb code, DCI inserts an initial byte of padding, if
necessary, to achieve two-byte alignment.
You can use DCI to insert a bit pattern into the instruction stream. For example, use:
DCI 0x46c0
Example macro
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.15 DCD and DCDU on page 14-786.
14.21 DCW and DCWU on page 14-792.
Syntax
{label} DCQ{U} {-}literal{,{-}literal}...
where:
literal
is a 64-bit numeric literal.
The range of numbers permitted is 0 to 264–1.
In addition to the characters normally permitted in a numeric literal, you can prefix
literal with a minus sign. In this case, the range of numbers permitted is –263 to –1.
The result of specifying -n is the same as the result of specifying 264–n.
Usage
DCQ inserts up to three bytes of padding before the first defined eight-byte block, if necessary, to
achieve four-byte alignment.
Use DCQU if you do not require alignment.
Example
Incorrect example
number EQU 2
DCQU number ; DCQ and DCQU only accept literals not
; expressions.
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.14 DCB on page 14-785.
14.15 DCD and DCDU on page 14-786.
14.21 DCW and DCWU on page 14-792.
14.63 SPACE or FILL on page 14-843.
Syntax
{label} DCW{U} expr{,expr}...
where:
expr
is a numeric expression that evaluates to an integer in the range –32768 to 65535.
Usage
DCW inserts a byte of padding before the first defined halfword if necessary to achieve two-byte
alignment.
Use DCWU if you do not require alignment.
Examples
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.14 DCB on page 14-785.
14.15 DCD and DCDU on page 14-786.
14.20 DCQ and DCQU on page 14-791.
14.63 SPACE or FILL on page 14-843.
14.22 END
The END directive informs the assembler that it has reached the end of a source file.
Syntax
END
Usage
Every assembly language source file must end with END on a line by itself.
If the source file has been included in a parent file by a GET directive, the assembler returns to the
parent file and continues assembly at the first line following the GET directive.
If END is reached in the top-level source file during the first pass without any errors, the second
pass begins.
If END is reached in the top-level source file during the second pass, the assembler finishes the
assembly and writes the appropriate output.
Related references
14.42 GET or INCLUDE on page 14-815.
14.23 ENTRY
The ENTRY directive declares an entry point to a program.
Syntax
ENTRY
Usage
A program must have an entry point. You can specify an entry point in the following ways:
• Using the ENTRY directive in assembly language source code.
• Providing a main() function in C or C++ source code.
• Using the armlink --entry command-line option.
You can declare more than one entry point in a program, although a source file cannot contain
more than one ENTRY directive. For example, a program could contain multiple assembly
language source files, each with an ENTRY directive. Or it could contain a C or C++ file with a
main() function and one or more assembly source files with an ENTRY directive.
If the program contains multiple entry points, then you must select one of them. You do this by
exporting the symbol for the ENTRY directive that you want to use as the entry point, then using
the armlink --entry option to select the exported symbol.
Example
When you invoke armlink, if other entry points are declared in the program, then you must
specify --entry=ep1, to select ep1.
14.24 EQU
The EQU directive gives a symbolic name to a numeric constant, a register-relative value or a PC-
relative value.
* is a synonym for EQU.
Syntax
name EQU expr{, type}
where:
name
is the symbolic name to assign to the value.
expr
is a register-relative address, a PC-relative address, an absolute address, or a 32-bit
integer constant.
type
is optional. type can be any one of:
• ARM.
• THUMB.
• CODE32.
• CODE16.
• DATA.
You can use type only if expr is an absolute address. If name is exported, the name
entry in the symbol table in the object file is marked as ARM, THUMB, CODE32, CODE16,
or DATA, according to type. This can be used by the linker.
Usage
Use EQU to define constants. This is similar to the use of #define to define a constant in C.
Examples
Related references
14.47 KEEP on page 14-822.
14.25 EXPORT or GLOBAL on page 14-796.
Syntax
EXPORT {[WEAK]}
EXPORT symbol {[SIZE=n]}
EXPORT symbol {[type{,set}]}
EXPORT symbol [attr{,type{,set}}{,SIZE=n}]
EXPORT symbol [WEAK {,attr}{,type{,set}}{,SIZE=n}]
where:
symbol
is the symbol name to export. The symbol name is case-sensitive. If symbol is omitted,
all symbols are exported.
WEAK
symbol is only imported into other sources if no other source exports an alternative
symbol. If [WEAK] is used without symbol, all exported symbols are weak.
attr
can be any one of:
DYNAMIC
sets the ELF symbol visibility to STV_DEFAULT.
PROTECTED
sets the ELF symbol visibility to STV_PROTECTED.
HIDDEN
sets the ELF symbol visibility to STV_HIDDEN.
INTERNAL
sets the ELF symbol visibility to STV_INTERNAL.
type
specifies the symbol type:
DATA
symbol is treated as data when the source is assembled and linked.
CODE
symbol is treated as code when the source is assembled and linked.
ELFTYPE=n
symbol is treated as a particular ELF symbol, as specified by the value of n,
where n can be any number from 0 to 15.
If unspecified, the assembler determines the most appropriate type. Usually the
assembler determines the correct type so you are not required to specify the type.
set
specifies the instruction set:
ARM
symbol is treated as an ARM symbol.
THUMB
symbol is treated as a Thumb symbol.
If unspecified, the assembler determines the most appropriate set.
n
specifies the size and can be any 32-bit value. If the SIZE attribute is not specified, the
assembler calculates the size:
• For PROC and FUNCTION symbols, the size is set to the size of the code until its ENDP
or ENDFUNC.
• For other symbols, the size is the size of instruction or data on the same source line. If
there is no instruction or data, the size is zero.
Usage
Use EXPORT to give code in other files access to symbols in the current file.
Use the [WEAK] attribute to inform the linker that a different instance of symbol takes
precedence over this one, if a different one is available from another source. You can use the
[WEAK] attribute with any of the symbol visibility attributes.
Example
AREA Example,CODE,READONLY
EXPORT DoAdd ; Export the function name
; to be used by external
; modules.
DoAdd ADD r0,r0,r1
Symbol visibility can be overridden for duplicate exports. In the following example, the last
EXPORT takes precedence for both binding and visibility:
Related references
14.44 IMPORT and EXTERN on page 14-818.
Related information
ELF for the ARM Architecture.
14.26 EXPORTAS
The EXPORTAS directive enables you to export a symbol from the object file, corresponding to a
different symbol in the source file.
Syntax
EXPORTAS symbol1, symbol2
where:
symbol1
is the symbol name in the source file. symbol1 must have been defined already. It can be
any symbol, including an area name, a label, or a constant.
symbol2
is the symbol name you want to appear in the object file.
The symbol names are case-sensitive.
Usage
Use EXPORTAS to change a symbol in the object file without having to change every instance in
the source file.
Examples
Related references
14.25 EXPORT or GLOBAL on page 14-796.
Syntax
FRAME ADDRESS reg[,offset]
where:
reg
is the register on which the canonical frame address is to be based. This is SP unless the
function uses a separate frame pointer.
offset
is the offset of the canonical frame address from reg. If offset is zero, you can omit it.
Usage
Use FRAME ADDRESS if your code alters which register the canonical frame address is based on,
or if it changes the offset of the canonical frame address from the register. You must use FRAME
ADDRESS immediately after the instruction that changes the calculation of the canonical frame
address.
Note
If your code uses a single instruction to save registers and alter the stack pointer, you can use
FRAME PUSH instead of using both FRAME ADDRESS and FRAME SAVE.
If your code uses a single instruction to load registers and alter the stack pointer, you can use
FRAME POP instead of using both FRAME ADDRESS and FRAME RESTORE.
Example
Related references
14.28 FRAME POP on page 14-800.
14.29 FRAME PUSH on page 14-801.
Syntax
There are the following alternative syntaxes for FRAME POP:
FRAME POP {reglist}
FRAME POP {reglist},n
FRAME POP n
where:
reglist
is a list of registers restored to the values they had on entry to the function. There must be
at least one register in the list.
n
is the number of bytes that the stack pointer moves.
Usage
FRAME POP is equivalent to a FRAME ADDRESS and a FRAME RESTORE directive. You can use it
when a single instruction loads registers and alters the stack pointer.
You must use FRAME POP immediately after the instruction it refers to.
If n is not specified or is zero, the assembler calculates the new offset for the canonical frame
address from {reglist}. It assumes that:
• Each ARM register popped occupies four bytes on the stack.
• Each VFP single-precision register popped occupies four bytes on the stack, plus an extra four-
byte word for each list.
• Each VFP double-precision register popped occupies eight bytes on the stack, plus an extra
four-byte word for each list.
Related references
14.27 FRAME ADDRESS on page 14-799.
14.31 FRAME RESTORE on page 14-803.
Syntax
There are the following alternative syntaxes for FRAME PUSH:
FRAME PUSH {reglist}
FRAME PUSH {reglist},n
FRAME PUSH n
where:
reglist
is a list of registers stored consecutively below the canonical frame address. There must
be at least one register in the list.
n
is the number of bytes that the stack pointer moves.
Usage
FRAME PUSH is equivalent to a FRAME ADDRESS and a FRAME SAVE directive. You can use it
when a single instruction saves registers and alters the stack pointer.
You must use FRAME PUSH immediately after the instruction it refers to.
If n is not specified or is zero, the assembler calculates the new offset for the canonical frame
address from {reglist}. It assumes that:
• Each ARM register pushed occupies four bytes on the stack.
• Each VFP single-precision register pushed occupies four bytes on the stack, plus an extra four-
byte word for each list.
• Each VFP double-precision register popped occupies eight bytes on the stack, plus an extra
four-byte word for each list.
Example
Related references
14.27 FRAME ADDRESS on page 14-799.
14.33 FRAME SAVE on page 14-805.
Syntax
FRAME REGISTER reg1, reg2
where:
reg1
is the register that held the argument on entry to the function.
reg2
is the register in which the value is preserved.
Usage
Use the FRAME REGISTER directive when you use a register to preserve an argument that was
held in a different register on entry to a function.
Syntax
FRAME RESTORE {reglist}
where:
reglist
is a list of registers whose contents have been restored. There must be at least one register
in the list.
Usage
Use FRAME RESTORE immediately after the callee reloads registers from the stack. You do not
have to do this after the last instruction in a function.
reglist can contain integer registers or floating-point registers, but not both.
Note
If your code uses a single instruction to load registers and alter the stack pointer, you can use
FRAME POP instead of using both FRAME RESTORE and FRAME ADDRESS.
Related references
14.28 FRAME POP on page 14-800.
Note
Any function that uses a register other than LR for its return address is not AAPCS compliant.
Such a function must not be exported.
Syntax
FRAME RETURN ADDRESS reg
where:
reg
is the register used for the return address.
Usage
Use the FRAME RETURN ADDRESS directive in any function that does not use LR for its return
address. Otherwise, a debugger cannot backtrace through the function.
Use FRAME RETURN ADDRESS immediately after the FUNCTION or PROC directive that
introduces the function.
Syntax
FRAME SAVE {reglist}, offset
where:
reglist
is a list of registers stored consecutively starting at offset from the canonical frame
address. There must be at least one register in the list.
Usage
Use FRAME SAVE immediately after the callee stores registers onto the stack.
reglist can include registers which are not required for backtracing. The assembler determines
which registers it requires to record in the DWARF call frame information.
Note
If your code uses a single instruction to save registers and alter the stack pointer, you can use
FRAME PUSH instead of using both FRAME SAVE and FRAME ADDRESS.
Related references
14.29 FRAME PUSH on page 14-801.
Syntax
FRAME STATE REMEMBER
Usage
During an inline exit sequence the information about calculation of canonical frame address and
locations of saved register values can change. After the exit sequence another branch can continue
using the same information as before. Use FRAME STATE REMEMBER to preserve this
information, and FRAME STATE RESTORE to restore it.
These directives can be nested. Each FRAME STATE RESTORE directive must have a
corresponding FRAME STATE REMEMBER directive.
Example
; function code
FRAME STATE REMEMBER
; save frame state before in-line exit sequence
POP {r4-r6,pc}
; do not have to FRAME POP here, as control has
; transferred out of the function
FRAME STATE RESTORE
; end of exit sequence, so restore state
exitB ; code for exitB
POP {r4-r6,pc}
ENDP
Related references
14.35 FRAME STATE RESTORE on page 14-807.
14.38 FUNCTION or PROC on page 14-810.
Syntax
FRAME STATE RESTORE
Related references
14.34 FRAME STATE REMEMBER on page 14-806.
14.38 FUNCTION or PROC on page 14-810.
Syntax
FRAME UNWIND ON
Usage
You can use this directive outside functions. In this case, the assembler produces unwind tables
for all following functions until it reaches a FRAME UNWIND OFF directive.
Note
A FRAME UNWIND directive is not sufficient to turn on exception table generation. Furthermore a
FRAME UNWIND directive, without other FRAME directives, is not sufficient information for the
assembler to generate the unwind information.
Related references
9.31 --exceptions, --no_exceptions on page 9-250.
9.32 --exceptions_unwind, --no_exceptions_unwind on page 9-251.
Syntax
FRAME UNWIND OFF
Usage
You can use this directive outside functions. In this case, the assembler produces no unwind tables
for all following functions until it reaches a FRAME UNWIND ON directive.
Related references
9.31 --exceptions, --no_exceptions on page 9-250.
9.32 --exceptions_unwind, --no_exceptions_unwind on page 9-251.
Syntax
label FUNCTION [{reglist1} [, {reglist2}]]
where:
reglist1
is an optional list of callee-saved ARM registers. If reglist1 is not present, and your
debugger checks register usage, it assumes that the AAPCS is in use. If you use empty
brackets, this informs the debugger that all ARM registers are caller-saved.
reglist2
is an optional list of callee-saved VFP registers. If you use empty brackets, this informs
the debugger that all VFP registers are caller-saved.
Usage
Use FUNCTION to mark the start of functions. The assembler uses FUNCTION to identify the start
of a function when producing DWARF call frame information for ELF.
FUNCTION sets the canonical frame address to be R13 (SP), and the frame state stack to be empty.
Each FUNCTION directive must have a matching ENDFUNC directive. You must not nest
FUNCTION and ENDFUNC pairs, and they must not contain PROC or ENDP directives.
You can use the optional reglist parameters to inform the debugger about an alternative
procedure call standard, if you are using your own. Not all debuggers support this feature. See
your debugger documentation for details.
If you specify an empty reglist, using {}, this indicates that all registers for the function are
caller-saved. Typically you do this when writing a reset vector where the values in all registers are
unknown on execution. This avoids problems in a debugger if it tries to construct a backtrace from
the values in the registers.
Note
FUNCTION does not automatically cause alignment to a word boundary (or halfword boundary for
Thumb). Use ALIGN if necessary to ensure alignment, otherwise the call frame might not point to
the start of the function.
Examples
Related references
14.35 FRAME STATE RESTORE on page 14-807.
Related references
14.38 FUNCTION or PROC on page 14-810.
14.40 FIELD
The FIELD directive describes space within a storage map that has been defined using the MAP
directive.
# is a synonym for FIELD.
Syntax
{label} FIELD expr
where:
label
is an optional label. If specified, label is assigned the value of the storage location
counter, {VAR}. The storage location counter is then incremented by the value of expr.
expr
is an expression that evaluates to the number of bytes to increment the storage counter.
Usage
If a storage map is set by a MAP directive that specifies a base-register, the base register is
implicit in all labels defined by following FIELD directives, until the next MAP directive. These
register-relative labels can be quoted in load and store instructions.
Examples
The following example shows how register-relative labels are defined using the MAP and FIELD
directives:
When using the MAP and FIELD directives, you must ensure that the values are consistent in both
passes. The following example shows a use of MAP and FIELD that causes inconsistent values for
the symbol x. In the first pass sym is not defined, so x is at 0x04+R9. In the second pass, sym is
defined, so x is at 0x00+R0. This example results in an assembly error.
MAP 0, r0
if :LNOT: :DEF: sym
MAP 0, r9
FIELD 4 ; x is at 0x04+R9 in first pass
ENDIF
x FIELD 4 ; x is at 0x00+R0 in second pass
sym LDR r0, x ; inconsistent values for x results in assembly error
Related concepts
1.3 How the assembler works on page 1-29.
Related references
14.51 MAP on page 14-828.
1.4 Directives that can be omitted in pass 2 of the assembler on page 1-31.
Syntax
<gblx> variable
where:
<gblx>
is one of GBLA, GBLL, or GBLS.
variable
is the name of the variable. variable must be unique among symbols within a source
file.
Usage
Using one of these directives for a variable that is already defined re-initializes the variable.
The scope of the variable is limited to the source file that contains it.
Set the value of the variable with a SETA, SETL, or SETS directive.
Global variables can also be set with the --predefine assembler command-line option.
Examples
The following example declares a variable objectsize, sets the value of objectsize to 0xFF,
and then uses it later in a SPACE directive:
The following example shows how to declare and set a variable when you invoke armasm. Use
this when you want to set the value of a variable at assembly time. --pd is a synonym for --
predefine.
Related references
14.48 LCLA, LCLL, and LCLS on page 14-823.
14.62 SETA, SETL, and SETS on page 14-842.
9.58 --predefine "directive" on page 9-278.
Syntax
GET filename
where:
filename
is the name of the file to be included in the assembly. The assembler accepts pathnames
in either UNIX or MS-DOS format.
Usage
GET is useful for including macro definitions, EQUs, and storage maps in an assembly. When
assembly of the included file is complete, assembly continues at the line following the GET
directive.
By default the assembler searches the current place for included files. The current place is the
directory where the calling file is located. Use the -i assembler command line option to add
directories to the search path. File names and directory names containing spaces must not be
enclosed in double quotes ( " " ).
The included file can contain additional GET directives to include other files.
If the included file is in a different directory from the current place, this becomes the current place
until the end of the included file. The previous current place is then restored.
You cannot use GET to include object files.
Examples
Related references
14.45 INCBIN on page 14-820.
14.2 About assembly control directives on page 14-769.
Syntax
IF logical-expression
…;code
{ELSE
…;code}
ENDIF
where:
logical-expression
is an expression that evaluates to either {TRUE} or {FALSE}.
Usage
Use IF with ENDIF, and optionally with ELSE, for sequences of instructions or directives that are
only to be assembled or acted on under a specified condition.
IF...ENDIF conditions can be nested.
The IF directive introduces a condition that controls whether to assemble a sequence of
instructions and directives. [ is a synonym for IF.
The ELSE directive marks the beginning of a sequence of instructions or directives that you want
to be assembled if the preceding condition fails. | is a synonym for ELSE.
The ENDIF directive marks the end of a sequence of instructions or directives that you want to be
conditionally assembled. ] is a synonym for ENDIF.
The ELIF directive creates a structure equivalent to ELSE IF, without the requirement for nesting
or repeating the condition.
Using ELIF
Without using ELIF, you can construct a nested set of conditional instructions like this:
IF logical-expression
instructions
ELSE
IF logical-expression2
instructions
ELSE
IF logical-expression3
instructions
ENDIF
ENDIF
ENDIF
IF logical-expression
instructions
ELIF logical-expression2
instructions
ELIF logical-expression3
instructions
ENDIF
This structure only adds one to the current nesting depth, for the IF...ENDIF pair.
Examples
The following example assembles the first set of instructions if NEWVERSION is defined, or the
alternative set otherwise:
Assembly conditional on a variable being defined
IF :DEF:NEWVERSION
; first set of instructions or directives
ELSE
; alternative set of instructions or directives
ENDIF
Invoking armasm as follows defines NEWVERSION, so the first set of instructions and directives
are assembled:
Invoking armasm as follows leaves NEWVERSION undefined, so the second set of instructions and
directives are assembled:
armasm test.s
The following example assembles the first set of instructions if NEWVERSION has the value
{TRUE}, or the alternative set otherwise:
Assembly conditional on a variable value
IF NEWVERSION = {TRUE}
; first set of instructions or directives
ELSE
; alternative set of instructions or directives
ENDIF
Invoking armasm as follows causes the first set of instructions and directives to be assembled:
Invoking armasm as follows causes the second set of instructions and directives to be assembled:
Related references
7.25 Relational operators on page 7-170.
14.2 About assembly control directives on page 14-769.
Syntax
directive symbol {[SIZE=n]}
directive symbol {[type]}
directive symbol [attr{,type}{,SIZE=n}]
directive symbol[WEAK {,attr}{,type}{,SIZE=n}]
where:
directive
can be either:
IMPORT
imports the symbol unconditionally.
EXTERN
imports the symbol only if it is referred to in the current assembly.
symbol
is a symbol name defined in a separately assembled source file, object file, or library. The
symbol name is case-sensitive.
WEAK
prevents the linker generating an error message if the symbol is not defined elsewhere. It
also prevents the linker searching libraries that are not already included.
attr
can be any one of:
DYNAMIC
sets the ELF symbol visibility to STV_DEFAULT.
PROTECTED
sets the ELF symbol visibility to STV_PROTECTED.
HIDDEN
sets the ELF symbol visibility to STV_HIDDEN.
INTERNAL
sets the ELF symbol visibility to STV_INTERNAL.
type
specifies the symbol type:
DATA
symbol is treated as data when the source is assembled and linked.
CODE
symbol is treated as code when the source is assembled and linked.
ELFTYPE=n
symbol is treated as a particular ELF symbol, as specified by the value of n,
where n can be any number from 0 to 15.
If unspecified, the linker determines the most appropriate type.
n
specifies the size and can be any 32-bit value. If the SIZE attribute is not specified, the
assembler calculates the size:
• For PROC and FUNCTION symbols, the size is set to the size of the code until its ENDP
or ENDFUNC.
• For other symbols, the size is the size of instruction or data on the same source line. If
there is no instruction or data, the size is zero.
Usage
The name is resolved at link time to a symbol defined in a separate object file. The symbol is
treated as a program address. If [WEAK] is not specified, the linker generates an error if no
corresponding symbol is found at link time.
If [WEAK] is specified and no corresponding symbol is found at link time:
• If the reference is the destination of a B or BL instruction, the value of the symbol is taken as
the address of the following instruction. This makes the B or BL instruction effectively a NOP.
• Otherwise, the value of the symbol is taken as zero.
Example
The example tests to see if the C++ library has been linked, and branches conditionally on the
result.
Related references
14.25 EXPORT or GLOBAL on page 14-796.
Related information
ELF for the ARM Architecture.
14.45 INCBIN
The INCBIN directive includes a file within the file being assembled. The file is included as it is,
without being assembled.
Syntax
INCBIN filename
where:
filename
is the name of the file to be included in the assembly. The assembler accepts pathnames
in either UNIX or MS-DOS format.
Usage
You can use INCBIN to include executable files, literals, or any arbitrary data. The contents of the
file are added to the current ELF section, byte for byte, without being interpreted in any way.
Assembly continues at the line following the INCBIN directive.
By default, the assembler searches the current place for included files. The current place is the
directory where the calling file is located. Use the -i assembler command line option to add
directories to the search path. File names and directory names containing spaces must not be
enclosed in double quotes ( " " ).
Example
14.46 INFO
The INFO directive supports diagnostic generation on either pass of the assembly.
! is very similar to INFO, but has less detailed reporting.
Syntax
INFO numeric-expression, string-expression{, severity}
where:
numeric-expression
is a numeric expression that is evaluated during assembly. If the expression evaluates to
zero:
• No action is taken during pass one.
• string-expression is printed as a warning during pass two if severity is 1.
• string-expression is printed as a message during pass two if severity is 0 or
not specified.
If the expression does not evaluate to zero:
• string-expression is printed as an error message and the assembly fails
irrespective of whether severity is specified or not (non-zero values for severity
are reserved in this case).
string-expression
is an expression that evaluates to a string.
severity
is an optional number that controls the severity of the message. Its value can be either 0
or 1. All other values are reserved.
Usage
INFO provides a flexible means of creating custom error messages.
Examples
Related concepts
7.12 String expressions on page 7-156.
7.14 Numeric expressions on page 7-158.
Related references
14.8 ASSERT on page 14-779.
14.47 KEEP
The KEEP directive instructs the assembler to retain named local labels in the symbol table in the
object file.
Syntax
KEEP {label}
where:
label
is the name of the local label to keep. If label is not specified, all named local labels are
kept except register-relative labels.
Usage
By default, the only labels that the assembler describes in its output object file are:
• Exported labels.
• Labels that are relocated against.
Use KEEP to preserve local labels. This can help when debugging. Kept labels appear in the ARM
debuggers and in linker map files.
KEEP cannot preserve register-relative labels or numeric local labels.
Example
Related concepts
7.10 Numeric local labels on page 7-154.
Related references
14.51 MAP on page 14-828.
Syntax
<lclx> variable
where:
<lclx>
is one of LCLA, LCLL, or LCLS.
variable
is the name of the variable. variable must be unique within the macro that contains it.
Usage
Using one of these directives for a variable that is already defined re-initializes the variable.
The scope of the variable is limited to a particular instantiation of the macro that contains it.
Set the value of the variable with a SETA, SETL, or SETS directive.
Example
Related references
14.41 GBLA, GBLL, and GBLS on page 14-814.
14.62 SETA, SETL, and SETS on page 14-842.
14.50 MACRO and MEND on page 14-825.
14.49 LTORG
The LTORG directive instructs the assembler to assemble the current literal pool immediately.
Syntax
LTORG
Usage
The assembler assembles the current literal pool at the end of every code section. The end of a
code section is determined by the AREA directive at the beginning of the following section, or the
end of the assembly.
These default literal pools can sometimes be out of range of some LDR, VLDR, and WLDR pseudo-
instructions. Use LTORG to ensure that a literal pool is assembled within range.
Large programs can require several literal pools. Place LTORG directives after unconditional
branches or subroutine return instructions so that the processor does not attempt to execute the
constants as instructions.
The assembler word-aligns data in literal pools.
Example
Related references
10.45 LDR pseudo-instruction on page 10-385.
12.56 VLDR pseudo-instruction on page 12-657.
13.4 Wireless MMX load and store instructions on page 13-759.
Syntax
These two directives define a macro. The syntax is:
MACRO
{$label} macroname{$cond} {$parameter{,$parameter}...}
; code
MEND
where:
$label
is a parameter that is substituted with a symbol given when the macro is invoked. The
symbol is usually a label.
macroname
is the name of the macro. It must not begin with an instruction or directive name.
$cond
is a special parameter designed to contain a condition code. Values other than valid
condition codes are permitted.
$parameter
is a parameter that is substituted when the macro is invoked. A default value for a
parameter can be set using this format:
$parameter="default value"
Double quotes must be used if there are any spaces within, or at either end of, the default
value.
Usage
If you start any WHILE...WEND loops or IF...ENDIF conditions within a macro, they must be
closed before the MEND directive is reached. You can use MEXIT to enable an early exit from a
macro, for example, from within a loop.
Within the macro body, parameters such as $label, $parameter or $cond can be used in the
same way as other variables. They are given new values each time the macro is invoked.
Parameters must begin with $ to distinguish them from ordinary symbols. Any number of
parameters can be used.
$label is optional. It is useful if the macro defines internal labels. It is treated as a parameter to
the macro. It does not necessarily represent the first instruction in the macro expansion. The macro
defines the locations of any labels.
Use | as the argument to use the default value of a parameter. An empty string is used if the
argument is omitted.
In a macro that uses several internal labels, it is useful to define each internal label as the base
label with a different suffix.
Use a dot between a parameter and following text, or a following parameter, if a space is not
required in the expansion. Do not use a dot between preceding text and a parameter.
You can use the $cond parameter for condition codes. Use the unary operator :REVERSE_CC: to
find the inverse condition code, and :CC_ENCODING: to find the 4-bit encoding of the condition
code.
Examples
; macro definition
MACRO ; start macro definition
$label xmac $p1,$p2
; code
$label.loop1 ; code
; code
BGE $label.loop1
$label.loop2 ; code
BL $p1
BGT $label.loop2
; code
ADR $p2
; code
MEND ; end macro definition
; macro invocation
abc xmac subr1,de ; invoke macro
; code ; this is what is
abcloop1 ; code ; is produced when
; code ; the xmac macro is
BGE abcloop1 ; expanded
abcloop2 ; code
BL subr1
BGT abcloop2
; code
ADR de
; code
Note
When variables are also being passed in as arguments, use of | might leave some variables
unsubstituted. To work around this, define the | in a LCLS or GBLS variable and pass this variable
as an argument instead of |. For example:
MACRO
Return$cond
[ {ARCHITECTURE} <> "4"
BX$cond lr
|
MOV$cond pc,lr
]
MEND
; macro invocation
fun PROC
CMP r0,#0
MOVEQ r0,#1
ReturnEQ
MOV r0,#0
Return
ENDP
END
Related concepts
4.21 About macros on page 4-94.
7.4 Assembly time substitution of variables on page 7-148.
Related references
14.52 MEXIT on page 14-829.
14.41 GBLA, GBLL, and GBLS on page 14-814.
14.48 LCLA, LCLL, and LCLS on page 14-823.
14.51 MAP
The MAP directive sets the origin of a storage map to a specified address.
The storage-map location counter, {VAR}, is set to the same address. ^ is a synonym for MAP.
Syntax
MAP expr{,base-register}
where:
expr
is a numeric or PC-relative expression:
• If base-register is not specified, expr evaluates to the address where the storage
map starts. The storage map location counter is set to this address.
• If expr is PC-relative, you must have defined the label before you use it in the map.
The map requires the definition of the label during the first pass of the assembler.
base-register
specifies a register. If base-register is specified, the address where the storage map
starts is the sum of expr, and the value in base-register at runtime.
Usage
Use the MAP directive in combination with the FIELD directive to describe a storage map.
Specify base-register to define register-relative labels. The base register becomes implicit in
all labels defined by following FIELD directives, until the next MAP directive. The register-relative
labels can be used in load and store instructions.
The MAP directive can be used any number of times to define multiple storage maps.
The {VAR} counter is set to zero before the first MAP directive is used.
Examples
MAP 0,r9
MAP 0xff,r9
Related concepts
1.3 How the assembler works on page 1-29.
Related references
14.40 FIELD on page 14-813.
1.4 Directives that can be omitted in pass 2 of the assembler on page 1-31.
14.52 MEXIT
The MEXIT directive exits a macro definition before the end.
Usage
Use MEXIT when you require an exit from within the body of a macro. Any unclosed
WHILE...WEND loops or IF...ENDIF conditions within the body of the macro are closed by the
assembler before the macro is exited.
Example
MACRO
$abc example abc $param1,$param2
; code
WHILE condition1
; code
IF condition2
; code
MEXIT
ELSE
; code
ENDIF
WEND
; code
MEND
Related references
14.50 MACRO and MEND on page 14-825.
14.53 NOFP
The NOFP directive ensures that there are no floating-point instructions in an assembly language
source file.
Syntax
NOFP
Usage
Use NOFP to ensure that no floating-point instructions are used in situations where there is no
support for floating-point instructions either in software or in target hardware.
If a floating-point instruction occurs after the NOFP directive, an Unknown opcode error is
generated and the assembly fails.
If a NOFP directive occurs after a floating-point instruction, the assembler generates the error:
Too late to ban floating point instructions
and the assembly fails.
14.54 OPT
The OPT directive sets listing options from within the source code.
Syntax
OPT n
where:
n
is the OPT directive setting. The following table lists the valid settings:
OPT n Effect
4 Page throw. Issues an immediate form feed and starts a new page.
Usage
Specify the --list= assembler option to turn on listing.
By default the --list= option produces a normal listing that includes variable declarations,
macro expansions, call-conditioned directives, and MEND directives. The listing is produced on the
second pass only. Use the OPT directive to modify the default listing options from within your
code.
You can use OPT to format code listings. For example, you can specify a new page before
functions and sections.
Example
Related references
9.44 --list=file on page 9-264.
Syntax
name directive expr{.type}{[x]}
where:
directive
is QN, DN, or SN.
name
is the name to be assigned to the extension register. name cannot be the same as any of
the predefined names.
expr
Can be:
• An expression that evaluates to a number in the range:
— 0-15 if you are using DN in VFPv2 or QN in NEON.
— 0-31 otherwise.
• A predefined register name, or a register name that has already been defined in a
previous directive.
type
is any NEON or VFP datatype.
[x]
is only available for NEON code. [x] is a scalar index into a register.
type and [x] are Extended notation.
Usage
Use QN, DN, or SN to allocate convenient names to extension registers, to help you to remember
what you use each one for.
Note
Avoid conflicting uses of the same register under different names.
Examples
varA DN d1.U16
varB DN d2.U16
varC DN d3.U16
VADD varA,varB,varC ; VADD.U16 d1,d2,d3
index DN d4.U16[0]
result QN q5.I32
VMULL result,varA,index ; VMULL.U16 q5,d1,d4[0]
Related concepts
8.10 NEON and VFP data types on page 8-187.
8.28 Overview of VFP directives and vector notation on page 8-206.
8.15 Extended notation on page 8-192.
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
2.14 Predeclared coprocessor names on page 2-49.
14.56 RELOC
The RELOC directive explicitly encodes an ELF relocation in an object file.
Syntax
RELOC n, symbol
RELOC n
where:
n
must be an integer in the range 0 to 255 or one of the relocation names defined in the
Application Binary Interface for the ARM Architecture.
symbol
can be any PC-relative label.
Usage
Use RELOC n, symbol to create a relocation with respect to the address labeled by symbol.
If used immediately after an ARM or Thumb instruction, RELOC results in a relocation at that
instruction. If used immediately after a DCB, DCW, or DCD, or any other data generating directive,
RELOC results in a relocation at the start of the data. Any addend to be applied must be encoded in
the instruction or in the data.
If the assembler has already emitted a relocation at that place, the relocation is updated with the
details in the RELOC directive, for example:
RELOC is faulted in all other cases, for example, after any non-data generating directive, LTORG,
ALIGN, or as the first thing in an AREA.
Use RELOC n to create a relocation with respect to the anonymous symbol, that is, symbol 0 of the
symbol table. If you use RELOC n without a preceding assembler generated relocation, the
relocation is with respect to the anonymous symbol.
Examples
IMPORT impsym
LDR r0,[pc,#-8]
RELOC 4, impsym
DCD 0
RELOC 2, sym
DCD 0,1,2,3,4 ; the final word is relocated
RELOC 38,sym2 ; R_ARM_TARGET1
DCD impsym
RELOC R_ARM_TARGET1 ; relocation code 38
Related information
Application Binary Interface for the ARM Architecture.
14.57 REQUIRE
The REQUIRE directive specifies a dependency between sections.
Syntax
REQUIRE label
where:
label
is the name of the required label.
Usage
Use REQUIRE to ensure that a related section is included, even if it is not directly called. If the
section containing the REQUIRE directive is included in a link, the linker also includes the section
containing the definition of the specified label.
Syntax
REQUIRE8 {bool}
PRESERVE8 {bool}
where:
bool
is an optional Boolean constant, either {TRUE} or {FALSE}.
Usage
Where required, if your code preserves eight-byte alignment of the stack, use PRESERVE8 to set
the PRES8 build attribute on your file. If your code does not preserve eight-byte alignment of the
stack, use PRESERVE8 {FALSE} to ensure that the PRES8 build attribute is not set. If there are
multiple REQUIRE8 or PRESERVE8 directives in a file, the assembler uses the value of the last
directive.
Note
If you omit both PRESERVE8 and PRESERVE8 {FALSE}, the assembler decides whether to set
the PRES8 build attribute or not, by examining instructions that modify the SP. ARM
recommends that you specify PRESERVE8 explicitly.
You can enable a warning with:
Examples
REQUIRE8
REQUIRE8 {TRUE} ; equivalent to REQUIRE8
REQUIRE8 {FALSE} ; equivalent to absence of REQUIRE8
PRESERVE8 {TRUE} ; equivalent to PRESERVE8
PRESERVE8 {FALSE} ; NOT exactly equivalent to absence of PRESERVE8
Related references
9.24 --diag_warning=tag[,tag,…] on page 9-243.
Related information
Eight-byte Stack Alignment.
14.59 RLIST
The RLIST (register list) directive gives a name to a set of general-purpose registers.
Syntax
name RLIST {list-of-registers}
where:
name
is the name to be given to the set of registers. name cannot be the same as any of the
predefined names.
list-of-registers
is a comma-delimited list of register names and register ranges. The register list must be
enclosed in braces.
Usage
Use RLIST to give a name to a set of registers to be transferred by the LDM or STM instructions.
LDM and STM always put the lowest physical register numbers at the lowest address in memory,
regardless of the order they are supplied to the LDM or STM instruction. If you have defined your
own symbolic register names it can be less apparent that a register list is not in increasing register
order.
Use the --diag_warning 1206 assembler option to ensure that the registers in a register list are
supplied in increasing register order. If registers are not supplied in increasing register order, a
warning is issued.
Example
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
2.14 Predeclared coprocessor names on page 2-49.
14.60 RN
The RN directive defines a name for a specified register.
Syntax
name RN expr
where:
name
is the name to be assigned to the register. name cannot be the same as any of the
predefined names.
expr
evaluates to a register number from 0 to 15.
Usage
Use RN to allocate convenient names to registers, to help you to remember what you use each
register for. Be careful to avoid conflicting uses of the same register under different names.
Examples
Related references
2.11 Predeclared core register names on page 2-46.
2.12 Predeclared extension register names on page 2-47.
2.13 Predeclared XScale register names on page 2-48.
2.14 Predeclared coprocessor names on page 2-49.
14.61 ROUT
The ROUT directive marks the boundaries of the scope of numeric local labels.
Syntax
{name} ROUT
where:
name
is the name to be assigned to the scope.
Usage
Use the ROUT directive to limit the scope of numeric local labels. This makes it easier for you to
avoid referring to a wrong label by accident. The scope of numeric local labels is the whole area if
there are no ROUT directives in it.
Use the name option to ensure that each reference is to the correct numeric local label. If the name
of a label or a reference to a label does not match the preceding ROUT directive, the assembler
generates an error message and the assembly fails.
Example
; code
routineA ROUT ; ROUT is not necessarily a routine
; code
3routineA ; code ; this label is checked
; code
BEQ %4routineA ; this reference is checked
; code
BGE %3 ; refers to 3 above, but not checked
; code
4routineA ; code ; this label is checked
; code
otherstuff ROUT ; start of next scope
Related concepts
7.10 Numeric local labels on page 7-154.
Related references
14.6 AREA on page 14-774.
Syntax
variable <setx> expr
where:
<setx>
is one of SETA, SETL, or SETS.
variable
is the name of a variable declared by a GBLA, GBLL, GBLS, LCLA, LCLL, or LCLS
directive.
expr
is an expression that is:
• numeric, for SETA
• logical, for SETL
• string, for SETS.
Usage
You must declare variable using a global or local declaration directive before using one of
these directives.
You can also predefine variable names on the command line.
Examples
GBLA VersionNumber
VersionNumber SETA 21
GBLL Debug
Debug SETL {TRUE}
GBLS VersionString
VersionString SETS "Version 1.0"
Related concepts
7.12 String expressions on page 7-156.
7.14 Numeric expressions on page 7-158.
7.17 Logical expressions on page 7-161.
Related references
14.41 GBLA, GBLL, and GBLS on page 14-814.
14.48 LCLA, LCLL, and LCLS on page 14-823.
9.58 --predefine "directive" on page 9-278.
Syntax
{label} SPACE expr
{label} FILL expr{,value{,valuesize}}
where:
label
is an optional label.
expr
evaluates to the number of bytes to fill or zero.
value
evaluates to the value to fill the reserved bytes with. value is optional and if omitted, it
is 0. value must be 0 in a NOINIT area.
valuesize
is the size, in bytes, of value. It can be any of 1, 2, or 4. valuesize is optional and if
omitted, it is 1.
Usage
Use the ALIGN directive to align any code following a SPACE or FILL directive.
Example
Related concepts
7.14 Numeric expressions on page 7-158.
Related references
14.14 DCB on page 14-785.
14.15 DCD and DCDU on page 14-786.
14.20 DCQ and DCQU on page 14-791.
14.21 DCW and DCWU on page 14-792.
14.5 ALIGN on page 14-772.
Syntax
TTL title
SUBT subtitle
where:
title
is the title.
subtitle
is the subtitle.
Usage
Use the TTL directive to place a title at the top of the pages of a listing file. If you want the title to
appear on the first page, the TTL directive must be on the first line of the source file.
Use additional TTL directives to change the title. Each new TTL directive takes effect from the top
of the next page.
Use SUBT to place a subtitle at the top of the pages of a listing file. Subtitles appear in the line
below the titles. If you want the subtitle to appear on the first page, the SUBT directive must be on
the first line of the source file.
Use additional SUBT directives to change subtitles. Each new SUBT directive takes effect from the
top of the next page.
Examples
Syntax
WHILE logical-expression
code
WEND
where:
logical-expression
is an expression that can evaluate to either {TRUE} or {FALSE}.
Usage
Use the WHILE directive, together with the WEND directive, to assemble a sequence of instructions
a number of times. The number of repetitions can be zero.
You can use IF...ENDIF conditions within WHILE...WEND loops.
WHILE...WEND loops can be nested.
Example
Related concepts
7.17 Logical expressions on page 7-161.
Related references
14.2 About assembly control directives on page 14-769.
Describes the technical changes that have been made to the armasm User Guide.
It contains the following:
• A.1 Revisions for armasm User Guide on page Appx-A-847.
Added the chapters from the Assembler Reference into the • 9 Assembler Command-line Options on page 9-213
armasm User Guide. The Assembler Reference is no longer • 10 ARM and Thumb Instructions on page 10-296
being provided as a separate document.
• 11 ThumbEE Instructions on page 11-585
• 12 NEON and VFP Instructions on page 12-592
• 13 Wireless MMX Technology Instructions on page
13-755
• 14 Directives Reference on page 14-766
Added the EXECONLY and ZEROALIGN AREA attributes, and 14.6 AREA on page 14-774
mentioned that CODEALIGN is the default for execute-only
sections.
Changed references to the assembler environment variable • 6.2 Specify command-line options with an
from ARMCCn_ASMOPT to ARMCC5_ASMOPT. environment variable on page 6-120
• 9.43 --licretry on page 9-263
--cpu and --fpu options are fully documented • 9.14 --cpu=name on page 9-230
• 9.35 --fpu=name on page 9-254
Added topics on via file syntax. • 6.3 Overview of via files on page 6-121
• 6.4 Via file syntax rules on page 6-122
Removed the topics --project, --no_project, -- • 9 Assembler Command-line Options on page 9-213
reinitialize_workdir, and --workdir.
Mentioned a difference in behavior between pre-UAL Thumb • 4.28 Assembly language changes after RVCT v2.1
syntax and UAL syntax for the LDR Rd,= const literal load on page 4-103
pseudo-instruction.
Clarified the difference between changing the assembler 2.3 Changing between ARM, Thumb, and ThumbEE state on
mode and changing the instruction set state. page 2-37
Mentioned that DMB, DSB and ISB cannot be conditional • 10.33 DMB on page 10-358
in ARM code. • 10.34 DSB on page 10-360
• 10.37 ISB on page 10-365
Corrected the available immediate ranges for • 12.110 VQRSHRN and VQRSHRUN (by immediate) on
VQ{R}SHR{U}N and mentioned the I16, I32, and I64 page 12-711
datatypes. • 12.113 VQSHRN and VQSHRUN (by immediate) on page
12-714
Mentioned that VFP vector mode and mixed mode are 8 NEON and VFP Programming on page 8-175
deprecated, for the following VFP instructions: VABS,
VADD, VDIV, VMLA, VMLS, VMUL, VNEG, VNMLA, VNMLS,
VNMUL, VSQRT, and VSUB.
Described the E suffix for the VCMP instruction. 12.34 VCMP, VCMPE on page 12-632
Added a topic about conditional assembly. 6.16 Conditional assembly on page 6-138
Clarified the difference between the --predefine 9.58 --predefine "directive" on page 9-278
assembler option and the -Dname compiler option.
Mentioned behaviour when using PC or SP with the • 10.62 MRS (PSR to general-purpose register) on page 10-409
MRS or MSR instructions. • 10.65 MSR (general-purpose register to PSR) on page 10-413
Added a note about using the ISB instruction in an 10.37 ISB on page 10-365
IT block on ARMv7-M.
Separated the V{R}SHR, V{R}SHRN and V{R}SRA • 12.130 VSHR (by immediate) on page 12-732
instruction descriptions and changed the descriptions • 12.131 VSHRN (by immediate) on page 12-733
of the valid immediate ranges.
• 12.134 VSRA (by immediate) on page 12-736
• 12.121 VRSHR (by immediate) on page 12-722
• 12.122 VRSHRN (by immediate) on page 12-723
• 12.125 VRSRA (by immediate) on page 12-726
Changed the terminology used for ARM architecture • 10.11 ADR (PC-relative) on page 10-323
versions and added explanatory table footnotes. • 10.12 ADR (register-relative) on page 10-325
• 10.41 LDR (immediate offset) on page 10-373
• 10.136 STR (register offset) on page 10-512
• 10.46 LDR, unprivileged on page 10-387
• 10.42 LDR (PC-relative) on page 10-376
• 10.44 LDR (register-relative) on page 10-382
Added the CPY and NEG pseudo-instructions. • 10.31 CPY pseudo-instruction on page 10-356
• 10.68 NEG pseudo-instruction on page 10-419
Expanded the Usage and Example sections for the 14.23 ENTRY on page 14-794
ENTRY directive.
Changed the ordering of some operands from vector, scalar, • 8.31 VFPASSERT SCALAR on page 8-210
vector to vector, vector, scalar, in the examples of VFP arithmetic • 8.32 VFPASSERT VECTOR on page 8-211
instructions.
Added links to the NEON and VFP data types topic from the Various NEON and VFP instructions
associated NEON and VFP instructions.
Mentioned that the FUNCTION directive can accept an empty 14.38 FUNCTION or PROC on page 14-810
reglist.
Clarified the range of addresses accessible to the ADR instruction and the •
ADRL pseudo-instruction in ARM state. • 10.13 ADRL pseudo-instruction on page
10-327
Changed the minor version component of the built-in variable 6.6 Built-in variables and constants on page
ARMASM_VERSION from one to two digits. 6-124
Changed the minor version component of the integer reported by the -- 9.71 --version_number on page 9-291
version_number option from one to two digits.
Added SC300 and SC000 to table of --compatible options. 9.10 --compatible=name on page 9-226
Changed ARMCC41* environment variables to ARMCCnn*. 6.2 Specify command-line options with an environment
Added a link to the topic Toolchain environment variables. variable on page 6-120
Added a topic on directives that can be omitted in pass 2 and 1.4 Directives that can be omitted in pass 2 of the
added a link to this topic from How the assembler works. assembler on page 1-31
Added that all instructions must appear in both passes. 1.3 How the assembler works on page 1-29
In the summary table, changed instruction mnemonics from: 12.1 Summary of NEON instructions on page 12-596
• VQRSHR to VQRSHR{U}N.
• VQSHR to VQSHR{U}N.
• VRSUBH to VRSUBHN.
• VSUBH to VSUBHN.
• VRADDH to VRADDHN.
Added GBLA count to the example. 14.65 WHILE and WEND on page 14-845
Made changes to ALinknames for MRS, MSR, SEV, SYS, and • 10.64 MSR (ARM register to system coprocessor
NOP instructions. register) on page 10-412
• 10.63 MRS (system coprocessor register to ARM
register) on page 10-411
• 10.149 SYS on page 10-535
• 10.103 SEV on page 10-469
• 10.69 NOP on page 10-420
Added topic on 2 pass assembler diagnostics. 6.15 Two pass assembler diagnostics on page 6-137
Added topic on How the assembler works. 1.3 How the assembler works on page 1-29
Changed the restrictions to say that Rt must be even- • 10.47 LDREX on page 10-389
numbered only in LDREXD and STREXD instructions. • 10.138 STREX on page 10-517
Mentioned the additional cases where SP and PC are • 10.47 LDREX on page 10-389
deprecated. • 10.10 ADD on page 10-320
• 10.56 MOV on page 10-402
• 10.39 LDC and LDC2 on page 10-368
Added example of inconsistent use of MAP and FIELD 14.40 FIELD on page 14-813
directives.
Changed --cpu PXA270 to --device PXA270. 13.1 About Wireless MMX Technology instructions on page
13-756
Split the General-purpose registers topic into two. The second • 2.9 General-purpose registers on page 2-44
topic is called Register accesses. • 2.10 Register accesses on page 2-45
Mentioned that PC is not considered to be a general-purpose 2.9 General-purpose registers on page 2-44
register and that the instruction topics describe when SP and PC
can be used.
Mentioned that the use of PC in reglist in 32-bit Thumb • 10.40 LDM on page 10-370
instructions is for LDM and POP only. • 10.134 STM on page 10-507
• 10.75 PUSH on page 10-431
• 10.74 POP on page 10-429
Added a note that ARM instructions are deprecated if reglist • 10.40 LDM on page 10-370
contains SP or PC (STM and PUSH), or both PC and LR (LDM and • 10.134 STM on page 10-507
POP). • 10.75 PUSH on page 10-431
• 10.74 POP on page 10-429
Added a topic on Instruction and directive relocations. 4.24 Instruction and directive relocations on page
4-98
Added a topic on Thumb code size diagnostics. 6.12 Thumb code size diagnostics on page 6-134
Added a topic on ARM and Thumb instruction portability 6.13 ARM and Thumb instruction portability
diagnostics. diagnostics on page 6-135
Added a link to Thumb code size diagnostics. 6.19 Instruction width selection in Thumb on page
6-142
Added that symbols beginning with $v must be avoided. 7.1 Symbol naming rules on page 7-145
Removed | as an alias for :OR: 7.24 Addition, subtraction, and logical operators on
page 7-169
Clarified that NEON is optionally available on ARMv7-A and 8.1 Architecture support for NEON and VFP on
ARMv7-R but not on ARMv7E-M. Clarified that ARMv7E-M page 8-177
adds only the VFP single-precision floating-point instructions.
Added a new topic on how to input assembly code using stdin. 6.5 Using stdin to input source code to the
assembler on page 6-123
Added the options --execstack and --no_execstack. 9.29 --execstack, --no_execstack on page 9-248
Updated the instruction summary table and footnotes with 10.1 ARM and Thumb instruction summary on page
ARMv7E-M. 10-301
Replaced "profile" with "architecture" when referring to ARMv6- 10.1 ARM and Thumb instruction summary on page
M, ARMv7-M, ARMv7-R, and ARMv7-A in the instruction 10-301
summary table and in the architecture sections of the instruction
descriptions.
Mentioned register-controlled shift in the description of 10.5 Syntax of Operand2 as a register with optional
Operand2. shift on page 10-312
Added register restrictions to ADR (PC-relative). 10.11 ADR (PC-relative) on page 10-323
Added register restrictions and deprecation information in LDR • 10.41 LDR (immediate offset) on page 10-373
and STR (immediate offset). • 10.135 STR (immediate offset) on page 10-509
Identified the ARM only instruction syntaxes in LDR and STR • 10.43 LDR (register offset) on page 10-379
(register offset). • 10.136 STR (register offset) on page 10-512
Added register restrictions and deprecation information, use of • 10.43 LDR (register offset) on page 10-379
SP, and use of PC in LDR and STR (register offset). • 10.136 STR (register offset) on page 10-512
Noted that PC-relative STR is available but deprecated. 10.42 LDR (PC-relative) on page 10-376
Added information about deprecation and use of SP in LDR (PC- 10.42 LDR (PC-relative) on page 10-376
relative).
In Restrictions on reglist in ARM instructions, added that reglist 10.40 LDM on page 10-370
containing both PC and LR in ARM LDM is deprecated.
Added register restriction for Rn and moved the statement "Rm 10.73 PLD, PLDW, and PLI on page 10-427
must not be PC" to this section.
Added restrictions on reglist in LDM and STM. • 10.40 LDM on page 10-370
• 10.134 STM on page 10-507
Added the statement "must not be PC" for each of the registers in 10.142 SWP and SWPB on page 10-525
the syntax.
Mentioned SUBS pc, lr in Use of PC and SP in ARM 10.10 ADD on page 10-320
instructions.
Removed the caution against the use of the S suffix when using 10.10 ADD on page 10-320
PC as Rd in User or System mode.
Mentioned the deprecated instructions that use PC. 10.10 ADD on page 10-320
Added more syntaxes that are only present in ARM code and 10.140 SUBS pc, lr on page 10-522
described the additional items in the syntax.
Documented the valid forms of the SUBS instruction in ARM and 10.140 SUBS pc, lr on page 10-522
Thumb, and added the caution to not use these instructions in
User or System mode.
Mentioned SUBS pc, lr in Use of PC and SP in ARM 10.14 AND on page 10-329
instructions.
Removed the caution against the use of the S suffix when using 10.14 AND on page 10-329
PC as Rd in User or System mode.
Added Register restrictions section to say Rn cannot be PC in 10.39 LDC and LDC2 on page 10-368
instructions that write back to Rn.
Mentioned that Rt cannot be PC. 10.51 MCR and MCR2 on page 10-396
Mentioned SUBS pc, lr in Use of PC and SP in ARM MOV. 10.56 MOV on page 10-402
Removed the caution against the use of the S suffix when using 10.56 MOV on page 10-402
PC as Rd in User or System mode.
Mentioned the deprecated instructions that use PC. 10.56 MOV on page 10-402
Mentioned that SP is not permitted in Thumb TST and TEQ • 10.152 TST on page 10-539
instructions, and is deprecated in ARM TST and TEQ instructions. • 10.151 TEQ on page 10-537
Added that Rn must be different from Rd in MUL and MLA before • 10.66 MUL on page 10-415
ARMv6. • 10.54 MLA on page 10-400
Added that Rn must be different from RdLo and RdHi before 10.166 UMULL on page 10-555
ARMv6.
Added that the Thumb instructions are available in ARMv7E-M. • 10.123 SMULxy on page 10-491
• 10.125 SMULWy on page 10-493
• 10.115 SMLALxy on page 10-482
• 10.122 SMUAD on page 10-490
• 10.121 SMMUL on page 10-489
• 10.112 SMLAD on page 10-479
• 10.114 SMLALD on page 10-481
• 10.164 UMAAL on page 10-553
• 10.76 QADD on page 10-432
• 10.174 USAD8 on page 10-563
• 10.129 SSAT16 on page 10-498
• 10.146 SXTB on page 10-530
• 10.72 PKHBT and PKHTB on page 10-425
DBG is available in ARMv6K and above in ARM, and in 10.32 DBG on page 10-357
ARMv6T2 and above in Thumb. Also mentioned that DBG
executes as NOP in ARMv6K and ARMv6T2.
Added figures for the operation of VSLI and VSRI. • 12.132 VSLI on page 12-734
• 12.135 VSRI on page 12-737
Added tables showing the register state before and after operation • 12.149 VUZP on page 12-753
of VUZP and VZIP. • 12.150 VZIP on page 12-754
Added that n can be a defined relocation name and added a 14.56 RELOC on page 14-835
related example in the examples section.
Added a note for a macro workaround when using |. 14.50 MACRO and MEND on page 14-825
Clarified the message to say that error generation is during 14.8 ASSERT on page 14-779
assembly rather than second pass of the assembly.
Clarified that n is any integer, and described the examples in the 14.5 ALIGN on page 14-772
examples sections.
Clarified the description of COMGROUP and GROUP. 14.6 AREA on page 14-774
Added link to 8 Byte Stack Alignment. 14.58 REQUIRE8 and PRESERVE8 on page 14-837
Added /hardfp and /softfp values to the --apcs option and 9.3 --apcs=qualifier…qualifier on page 9-218
added a link to the --apcs compiler option.