slonik/specs/sub_i.xml

638 lines
38 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" encoding="UTF-8" href="iform.xsl" version="1.0"?>
<!DOCTYPE instructionsection PUBLIC "-//ARM//DTD instructionsection //EN" "iform-p.dtd">
<!-- Copyright (c) 2010-2022 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-Confidential. This document may only be used and distributed in accordance with the terms of the agreement entered into by Arm and the party that Arm delivered this document to. -->
<instructionsection id="SUB_i" title="SUB, SUBS (immediate) -- AArch32" type="instruction">
<docvars>
<docvar key="instr-class" value="general" />
</docvars>
<heading>SUB, SUBS (immediate)</heading>
<desc>
<brief>
<para>Subtract (immediate)</para>
</brief>
<authored>
<para>Subtract (immediate) subtracts an immediate value from a register value, and writes the result to the destination register.</para>
<para>If the destination register is not the PC, the SUBS variant of the instruction updates the condition flags based on the result.</para>
<para>The field descriptions for <syntax>&lt;Rd&gt;</syntax> identify the encodings where the PC is permitted as the destination register. If the destination register is the PC:</para>
<list type="unordered">
<listitem><content>The SUB variant of the instruction is an interworking branch, see <xref linkend="BEICJFEH">Pseudocode description of operations on the AArch32 general-purpose registers and the PC</xref>.</content></listitem>
<listitem><content>The SUBS variant of the instruction performs an exception return without the use of the stack. In this case:<list type="unordered"><listitem><content>The PE branches to the address written to the PC, and restores <xref linkend="BEIDIGBH">PSTATE</xref> from SPSR_&lt;current_mode&gt;.</content></listitem><listitem><content>The PE checks SPSR_&lt;current_mode&gt; for an illegal return event. See <xref linkend="CHDDDJDB">Illegal return events from AArch32 state</xref>.</content></listitem><listitem><content>The instruction is <arm-defined-word>undefined</arm-defined-word> in Hyp mode, except for encoding T5 with <syntax>&lt;imm8&gt;</syntax> set to zero, which is the encoding for the <instruction>ERET</instruction> instruction, see <xref linkend="A32T32-base.instructions.ERET">ERET</xref>.</content></listitem><listitem><content>The instruction is <arm-defined-word>constrained unpredictable</arm-defined-word> in User mode and System mode.</content></listitem></list></content></listitem>
</list>
</authored>
<encodingnotes>
<para>For more information about the <arm-defined-word>constrained unpredictable</arm-defined-word> behavior of this instruction, see <xref linkend="CJAEGDJC">Architectural Constraints on UNPREDICTABLE behaviors</xref>, and particularly <xref linkend="CEGCDCGA">SUBS PC. LR and related instructions (A32)</xref> and <xref linkend="CEGDJHBD">SUBS PC, LR and related instructions (T32)</xref>.</para>
</encodingnotes>
<syntaxnotes>
<para>In the T32 instruction set, <syntax>MOVS{&lt;c&gt;}{&lt;q&gt;} PC, LR</syntax> is a pseudo-instruction for <syntax>SUBS{&lt;c&gt;}{&lt;q&gt;} PC, LR, #0</syntax>.</para>
</syntaxnotes>
</desc>
<operationalnotes>
<para>If CPSR.DIT is 1 and this instruction does not use R15 as either its source or destination:</para>
<list type="unordered">
<listitem><content>The execution time of this instruction is independent of:<list type="unordered"><listitem><content>The values of the data supplied in any of its registers.</content></listitem><listitem><content>The values of the NZCV flags.</content></listitem></list></content></listitem>
<listitem><content>The response of this instruction to asynchronous exceptions does not vary based on:<list type="unordered"><listitem><content>The values of the data supplied in any of its registers.</content></listitem><listitem><content>The values of the NZCV flags.</content></listitem></list></content></listitem>
</list>
</operationalnotes>
<alias_list howmany="0"></alias_list>
<classes>
<classesintro count="6">
<txt>It has encodings from the following instruction sets:</txt>
<txt> A32 (</txt>
<a href="#iclass_a1">A1</a>
<txt>)</txt>
<txt> and </txt>
<txt> T32 (</txt>
<a href="#iclass_t1">T1</a>
<txt>, </txt>
<a href="#iclass_t2">T2</a>
<txt>, </txt>
<a href="#iclass_t3">T3</a>
<txt>, </txt>
<a href="#iclass_t4">T4</a>
<txt> and </txt>
<a href="#iclass_t5">T5</a>
<txt>)</txt>
<txt>.</txt>
</classesintro>
<iclass name="A1" oneof="6" id="iclass_a1" no_encodings="2" isa="A32">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
</docvars>
<iclassintro count="2"></iclassintro>
<regdiagram form="32" psname="aarch32/instrs/SUB_i/A1_A.txt" tworows="1">
<box hibit="31" width="4" name="cond" usename="1" settings="4" constraint="!= 1111">
<c colspan="4">!= 1111</c>
</box>
<box hibit="27" width="4" settings="4">
<c>0</c>
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="23" width="3" name="opc" settings="3">
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="20" name="S" usename="1">
<c></c>
</box>
<box hibit="19" width="4" name="Rn" usename="1">
<c colspan="4"></c>
</box>
<box hibit="15" width="4" name="Rd" usename="1">
<c colspan="4"></c>
</box>
<box hibit="11" width="12" name="imm12" usename="1">
<c colspan="12"></c>
</box>
</regdiagram>
<encoding name="SUB_i_A1" oneofinclass="2" oneof="8" label="SUB" bitdiffs="S == 0 &amp;&amp; Rn != 11x1">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<box hibit="20" width="1" name="S">
<c>0</c>
</box>
<box hibit="19" width="4" name="Rn">
<c>N</c>
<c>N</c>
<c></c>
<c>N</c>
</box>
<asmtemplate><text>SUB</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd_1" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_2" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const_1" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
</encoding>
<encoding name="SUBS_i_A1" oneofinclass="2" oneof="8" label="SUBS" bitdiffs="S == 1 &amp;&amp; Rn != 1101">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="SUBS" />
</docvars>
<box hibit="20" width="1" name="S">
<c>1</c>
</box>
<box hibit="19" width="4" name="Rn">
<c>N</c>
<c>N</c>
<c>Z</c>
<c>N</c>
</box>
<asmtemplate><text>SUBS</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd_1" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_2" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const_1" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/A1_A.txt" mylink="aarch32.instrs.SUB_i.A1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if Rn == '1111' &amp;&amp; S == '0' then SEE "ADR";
if Rn == '1101' then SEE "SUB (SP minus immediate)";
d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); setflags = (S == '1'); imm32 = <a link="impl-aarch32.A32ExpandImm.1" file="shared_pseudocode.xml" hover="function: bits(32) A32ExpandImm(bits(12) imm12)">A32ExpandImm</a>(imm12);</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T1" oneof="6" id="iclass_t1" no_encodings="1" isa="T32">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="16" psname="aarch32/instrs/SUB_i/T1_A.txt">
<box hibit="31" width="6" settings="6">
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="25" name="S" settings="1">
<c>1</c>
</box>
<box hibit="24" width="3" name="imm3" usename="1">
<c colspan="3"></c>
</box>
<box hibit="21" width="3" name="Rn" usename="1">
<c colspan="3"></c>
</box>
<box hibit="18" width="3" name="Rd" usename="1">
<c colspan="3"></c>
</box>
</regdiagram>
<encoding name="SUB_i_T1" oneofinclass="1" oneof="8" label="T1">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<asmtemplate comment="Inside IT block"><text>SUB</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>, </text><a link="sa_rn" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_imm3" hover="3-bit unsigned immediate [0-7] (field &quot;imm3&quot;)">&lt;imm3&gt;</a></asmtemplate>
<asmtemplate comment="Outside IT block"><text>SUBS</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>, </text><a link="sa_rn" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_imm3" hover="3-bit unsigned immediate [0-7] (field &quot;imm3&quot;)">&lt;imm3&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/T1_A.txt" mylink="aarch32.instrs.SUB_i.T1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); setflags = !<a link="impl-aarch32.InITBlock.0" file="shared_pseudocode.xml" hover="function: boolean InITBlock()">InITBlock</a>(); imm32 = <a link="impl-shared.ZeroExtend.2" file="shared_pseudocode.xml" hover="function: bits(N) ZeroExtend(bits(M) x, integer N)">ZeroExtend</a>(imm3, 32);</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T2" oneof="6" id="iclass_t2" no_encodings="1" isa="T32">
<docvars>
<docvar key="armarmheading" value="T2" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="16" psname="aarch32/instrs/SUB_i/T2_A.txt">
<box hibit="31" width="3" settings="3">
<c>0</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="28" width="2" name="op" settings="2">
<c>1</c>
<c>1</c>
</box>
<box hibit="26" width="3" name="Rdn" usename="1">
<c colspan="3"></c>
</box>
<box hibit="23" width="8" name="imm8" usename="1">
<c colspan="8"></c>
</box>
</regdiagram>
<encoding name="SUB_i_T2" oneofinclass="1" oneof="8" label="T2">
<docvars>
<docvar key="armarmheading" value="T2" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<asmtemplate comment="Inside IT block, and &lt;Rdn&gt;, &lt;imm8&gt; can be represented in T1"><text>SUB</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>, #</text><a link="sa_imm8" hover="8-bit unsigned immediate [0-255] (field &quot;imm8&quot;)">&lt;imm8&gt;</a></asmtemplate>
<asmtemplate comment="Inside IT block, and &lt;Rdn&gt;, &lt;imm8&gt; cannot be represented in T1"><text>SUB</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>, #</text><a link="sa_imm8" hover="8-bit unsigned immediate [0-255] (field &quot;imm8&quot;)">&lt;imm8&gt;</a></asmtemplate>
<asmtemplate comment="Outside IT block, and &lt;Rdn&gt;, &lt;imm8&gt; can be represented in T1"><text>SUBS</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>, #</text><a link="sa_imm8" hover="8-bit unsigned immediate [0-255] (field &quot;imm8&quot;)">&lt;imm8&gt;</a></asmtemplate>
<asmtemplate comment="Outside IT block, and &lt;Rdn&gt;, &lt;imm8&gt; cannot be represented in T1"><text>SUBS</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rdn" hover="General-purpose source and destination register (field &quot;Rdn&quot;)">&lt;Rdn&gt;</a><text>, #</text><a link="sa_imm8" hover="8-bit unsigned immediate [0-255] (field &quot;imm8&quot;)">&lt;imm8&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/T2_A.txt" mylink="aarch32.instrs.SUB_i.T2_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rdn); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rdn); setflags = !<a link="impl-aarch32.InITBlock.0" file="shared_pseudocode.xml" hover="function: boolean InITBlock()">InITBlock</a>(); imm32 = <a link="impl-shared.ZeroExtend.2" file="shared_pseudocode.xml" hover="function: bits(N) ZeroExtend(bits(M) x, integer N)">ZeroExtend</a>(imm8, 32);</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T3" oneof="6" id="iclass_t3" no_encodings="2" isa="T32">
<docvars>
<docvar key="armarmheading" value="T3" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
</docvars>
<iclassintro count="2"></iclassintro>
<regdiagram form="16x2" psname="aarch32/instrs/SUB_i/T3_A.txt" tworows="1">
<box hibit="31" width="5" settings="5">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="26" name="i" usename="1">
<c></c>
</box>
<box hibit="25" settings="1">
<c>0</c>
</box>
<box hibit="24" width="4" name="op1" settings="4">
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="20" name="S" usename="1">
<c></c>
</box>
<box hibit="19" width="4" name="Rn" usename="1" settings="4" constraint="!= 1101">
<c colspan="4">!= 1101</c>
</box>
<box hibit="15" settings="1">
<c>0</c>
</box>
<box hibit="14" width="3" name="imm3" usename="1">
<c colspan="3"></c>
</box>
<box hibit="11" width="4" name="Rd" usename="1">
<c colspan="4"></c>
</box>
<box hibit="7" width="8" name="imm8" usename="1">
<c colspan="8"></c>
</box>
</regdiagram>
<encoding name="SUB_i_T3" oneofinclass="2" oneof="8" label="SUB" bitdiffs="S == 0">
<docvars>
<docvar key="armarmheading" value="T3" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<box hibit="20" width="1" name="S">
<c>0</c>
</box>
<asmtemplate comment="Inside IT block, and &lt;Rd&gt;, &lt;Rn&gt;, &lt;const&gt; can be represented in T1 or T2"><text>SUB</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>.W </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_1" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
<asmtemplate><text>SUB</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_1" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
</encoding>
<encoding name="SUBS_i_T3" oneofinclass="2" oneof="8" label="SUBS" bitdiffs="S == 1 &amp;&amp; Rd != 1111">
<docvars>
<docvar key="armarmheading" value="T3" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUBS" />
</docvars>
<box hibit="20" width="1" name="S">
<c>1</c>
</box>
<box hibit="11" width="4" name="Rd">
<c>N</c>
<c>N</c>
<c>N</c>
<c>N</c>
</box>
<asmtemplate comment="Outside IT block, and &lt;Rd&gt;, &lt;Rn&gt;, &lt;const&gt; can be represented in T1 or T2"><text>SUBS.W </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_1" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
<asmtemplate><text>SUBS</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_1" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_const" hover="An immediate value">&lt;const&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/T3_A.txt" mylink="aarch32.instrs.SUB_i.T3_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if Rd == '1111' &amp;&amp; S == '1' then SEE "CMP (immediate)";
if Rn == '1101' then SEE "SUB (SP minus immediate)";
d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); setflags = (S == '1'); imm32 = <a link="impl-aarch32.T32ExpandImm.1" file="shared_pseudocode.xml" hover="function: bits(32) T32ExpandImm(bits(12) imm12)">T32ExpandImm</a>(i:imm3:imm8);
if (d == 15 &amp;&amp; !setflags) || n == 15 then UNPREDICTABLE; // Armv8-A removes UNPREDICTABLE for R13</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T4" oneof="6" id="iclass_t4" no_encodings="1" isa="T32">
<docvars>
<docvar key="armarmheading" value="T4" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUBW" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="16x2" psname="aarch32/instrs/SUB_i/T4_A.txt" tworows="1">
<box hibit="31" width="5" settings="5">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="26" name="i" usename="1">
<c></c>
</box>
<box hibit="25" width="2" settings="2">
<c>1</c>
<c>0</c>
</box>
<box hibit="23" name="o1" settings="1">
<c>1</c>
</box>
<box hibit="22" settings="1">
<c>0</c>
</box>
<box hibit="21" name="o2" settings="1">
<c>1</c>
</box>
<box hibit="20" settings="1">
<c>0</c>
</box>
<box hibit="19" width="4" name="Rn" usename="1" settings="4" constraint="!= 11x1">
<c colspan="4">!= 11x1</c>
</box>
<box hibit="15" settings="1">
<c>0</c>
</box>
<box hibit="14" width="3" name="imm3" usename="1">
<c colspan="3"></c>
</box>
<box hibit="11" width="4" name="Rd" usename="1">
<c colspan="4"></c>
</box>
<box hibit="7" width="8" name="imm8" usename="1">
<c colspan="8"></c>
</box>
</regdiagram>
<encoding name="SUB_i_T4" oneofinclass="1" oneof="8" label="T4">
<docvars>
<docvar key="armarmheading" value="T4" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUBW" />
</docvars>
<asmtemplate comment="&lt;imm12&gt; cannot be represented in T1, T2, or T3"><text>SUB</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_2" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_imm12" hover="12-bit unsigned immediate [0-4095] (field &quot;i:imm3:imm8&quot;)">&lt;imm12&gt;</a></asmtemplate>
<asmtemplate comment="&lt;imm12&gt; can be represented in T1, T2, or T3"><text>SUBW</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> </text><text>{</text><a link="sa_rd" hover="General-purpose destination register (field &quot;Rd&quot;)">&lt;Rd&gt;</a><text>,</text><text>}</text><text> </text><a link="sa_rn_2" hover="General-purpose source register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text>, #</text><a link="sa_imm12" hover="12-bit unsigned immediate [0-4095] (field &quot;i:imm3:imm8&quot;)">&lt;imm12&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/T4_A.txt" mylink="aarch32.instrs.SUB_i.T4_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if Rn == '1111' then SEE "ADR";
if Rn == '1101' then SEE "SUB (SP minus immediate)";
d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); setflags = FALSE; imm32 = <a link="impl-shared.ZeroExtend.2" file="shared_pseudocode.xml" hover="function: bits(N) ZeroExtend(bits(M) x, integer N)">ZeroExtend</a>(i:imm3:imm8, 32);
if d == 15 then UNPREDICTABLE; // Armv8-A removes UNPREDICTABLE for R13</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T5" oneof="6" id="iclass_t5" no_encodings="1" isa="T32">
<docvars>
<docvar key="armarmheading" value="T5" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUBS" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="16x2" psname="aarch32/instrs/SUB_i/T5_AS.txt">
<box hibit="31" width="12" settings="12">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="19" width="4" name="Rn" usename="1">
<c colspan="4"></c>
</box>
<box hibit="15" width="2" settings="2">
<c>1</c>
<c>0</c>
</box>
<box hibit="13" settings="1">
<c>(0)</c>
</box>
<box hibit="12" settings="1">
<c>0</c>
</box>
<box hibit="11" settings="1">
<c>(1)</c>
</box>
<box hibit="10" settings="1">
<c>(1)</c>
</box>
<box hibit="9" settings="1">
<c>(1)</c>
</box>
<box hibit="8" settings="1">
<c>(1)</c>
</box>
<box hibit="7" width="8" name="imm8" usename="1">
<c colspan="8"></c>
</box>
</regdiagram>
<encoding name="SUBS_PC_T5_AS" oneofinclass="1" oneof="8" label="T5" bitdiffs="!(Rn == 1110 &amp;&amp; imm8 == 00000000)">
<docvars>
<docvar key="armarmheading" value="T5" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUBS" />
</docvars>
<box hibit="19" width="20" name="Rn:imm8">
<c>N</c>
<c>N</c>
<c>N</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
<c>Z</c>
</box>
<asmtemplate><text>SUBS</text><text>{</text><a link="sa_c" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;c&gt;</a><text>}</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> PC, LR, #</text><a link="sa_imm8_1" hover="8-bit unsigned immediate [0-255] (field &quot;imm8&quot;)">&lt;imm8&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/T5_AS.txt" mylink="aarch32.instrs.SUB_i.T5_AS.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if Rn == '1110' &amp;&amp; <a link="impl-shared.IsZero.1" file="shared_pseudocode.xml" hover="function: boolean IsZero(bits(N) x)">IsZero</a>(imm8) then SEE "ERET";
d = 15; n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); setflags = TRUE; imm32 = <a link="impl-shared.ZeroExtend.2" file="shared_pseudocode.xml" hover="function: bits(N) ZeroExtend(bits(M) x, integer N)">ZeroExtend</a>(imm8, 32);
if n != 14 then UNPREDICTABLE;
if <a link="impl-aarch32.InITBlock.0" file="shared_pseudocode.xml" hover="function: boolean InITBlock()">InITBlock</a>() &amp;&amp; !<a link="impl-aarch32.LastInITBlock.0" file="shared_pseudocode.xml" hover="function: boolean LastInITBlock()">LastInITBlock</a>() then UNPREDICTABLE;</pstext>
</ps>
</ps_section>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="SUB_i_A1, SUB_i_T1, SUB_i_T2, SUB_i_T3, SUB_i_T4, SUBS_PC_T5_AS" symboldefcount="1">
<symbol link="sa_c">&lt;c&gt;</symbol>
<account encodedin="">
<intro>
<para>See <xref linkend="Babbefhf">Standard assembler syntax fields</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_A1, SUB_i_T1, SUB_i_T2, SUB_i_T3, SUB_i_T4, SUBS_PC_T5_AS" symboldefcount="1">
<symbol link="sa_q">&lt;q&gt;</symbol>
<account encodedin="">
<intro>
<para>See <xref linkend="Babbefhf">Standard assembler syntax fields</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T2" symboldefcount="1">
<symbol link="sa_rdn">&lt;Rdn&gt;</symbol>
<account encodedin="Rdn">
<intro>
<para>Is the general-purpose source and destination register, encoded in the "Rdn" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T2" symboldefcount="1">
<symbol link="sa_imm8">&lt;imm8&gt;</symbol>
<account encodedin="imm8">
<docvars>
<docvar key="armarmheading" value="T2" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<intro>
<para>For encoding T2: is a 8-bit unsigned immediate, in the range 0 to 255, encoded in the "imm8" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUBS_PC_T5_AS" symboldefcount="2">
<symbol link="sa_imm8_1">&lt;imm8&gt;</symbol>
<account encodedin="imm8">
<docvars>
<docvar key="armarmheading" value="T5" />
<docvar key="mnemonic" value="SUBS" />
</docvars>
<intro>
<para>For encoding T5: is a 8-bit unsigned immediate, in the range 0 to 255, encoded in the "imm8" field. If <syntax>&lt;Rn&gt;</syntax> is the LR, and zero is used, see <xref linkend="A32T32-base.instructions.ERET">ERET</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_A1" symboldefcount="1">
<symbol link="sa_rd_1">&lt;Rd&gt;</symbol>
<account encodedin="Rd">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<intro>
<para>For encoding A1: is the general-purpose destination register, encoded in the "Rd" field. If omitted, this register is the same as <syntax>&lt;Rn&gt;</syntax>. If the PC is used:</para>
<list type="unordered">
<listitem><content>For the SUB variant, the instruction is a branch to the address calculated by the operation. This is an interworking branch, see <xref linkend="BEICJFEH">Pseudocode description of operations on the AArch32 general-purpose registers and the PC</xref>.</content></listitem>
<listitem><content>For the SUBS variant, the instruction performs an exception return, that restores <xref linkend="BEIDIGBH">PSTATE</xref> from SPSR_&lt;current_mode&gt;. Arm deprecates use of this instruction unless <syntax>&lt;Rn&gt;</syntax> is the LR.</content></listitem>
</list>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T1, SUB_i_T3, SUB_i_T4" symboldefcount="2">
<symbol link="sa_rd">&lt;Rd&gt;</symbol>
<account encodedin="Rd">
<docvars>
<docvar key="isa" value="T32" />
</docvars>
<intro>
<para>For encoding T1, T3 and T4: is the general-purpose destination register, encoded in the "Rd" field. If omitted, this register is the same as <syntax>&lt;Rn&gt;</syntax>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_A1, SUB_i_T4" symboldefcount="1">
<symbol link="sa_rn_2">&lt;Rn&gt;</symbol>
<account encodedin="Rn">
<intro>
<para>For encoding A1 and T4: is the general-purpose source register, encoded in the "Rn" field. If the SP is used, see <xref linkend="A32T32-base.instructions.SUB_SP_i">SUB (SP minus immediate)</xref>. If the PC is used, see <xref linkend="A32T32-base.instructions.ADR">ADR</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T1" symboldefcount="2">
<symbol link="sa_rn">&lt;Rn&gt;</symbol>
<account encodedin="Rn">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<intro>
<para>For encoding T1: is the general-purpose source register, encoded in the "Rn" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T3" symboldefcount="3">
<symbol link="sa_rn_1">&lt;Rn&gt;</symbol>
<account encodedin="Rn">
<docvars>
<docvar key="armarmheading" value="T3" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SUB" />
</docvars>
<intro>
<para>For encoding T3: is the general-purpose source register, encoded in the "Rn" field. If the SP is used, see <xref linkend="A32T32-base.instructions.SUB_SP_i">SUB (SP minus immediate)</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T1" symboldefcount="1">
<symbol link="sa_imm3">&lt;imm3&gt;</symbol>
<account encodedin="imm3">
<intro>
<para>Is a 3-bit unsigned immediate, in the range 0 to 7, encoded in the "imm3" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T4" symboldefcount="1">
<symbol link="sa_imm12">&lt;imm12&gt;</symbol>
<account encodedin="i:imm3:imm8">
<intro>
<para>Is a 12-bit unsigned immediate, in the range 0 to 4095, encoded in the "i:imm3:imm8" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_A1" symboldefcount="1">
<symbol link="sa_const_1">&lt;const&gt;</symbol>
<account encodedin="imm12">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="isa" value="A32" />
</docvars>
<intro>
<para>For encoding A1: an immediate value. See <xref linkend="BABHDAJF">Modified immediate constants in A32 instructions</xref> for the range of values.</para>
</intro>
</account>
</explanation>
<explanation enclist="SUB_i_T3" symboldefcount="2">
<symbol link="sa_const">&lt;const&gt;</symbol>
<account encodedin="i:imm3:imm8">
<docvars>
<docvar key="armarmheading" value="T3" />
<docvar key="isa" value="T32" />
</docvars>
<intro>
<para>For encoding T3: an immediate value. See <xref linkend="BABGHAGA">Modified immediate constants in T32 instructions</xref> for the range of values.</para>
</intro>
</account>
</explanation>
</explanations>
<ps_section howmany="1">
<ps name="aarch32/instrs/SUB_i/Op_A.txt" mylink="execute" enclabels="" sections="1" secttype="Operation">
<pstext mayhavelinks="1" section="Execute" rep_section="execute">if <a link="impl-aarch32.ConditionPassed.0" file="shared_pseudocode.xml" hover="function: boolean ConditionPassed()">ConditionPassed</a>() then
EncodingSpecificOperations();
(result, nzcv) = <a link="impl-shared.AddWithCarry.3" file="shared_pseudocode.xml" hover="function: (bits(N), bits(4)) AddWithCarry(bits(N) x, bits(N) y, bit carry_in)">AddWithCarry</a>(<a link="impl-aarch32.R.read.1" file="shared_pseudocode.xml" hover="accessor: bits(32) R[integer n]">R</a>[n], NOT(imm32), '1');
if d == 15 then
if setflags then
<a link="impl-aarch32.ALUExceptionReturn.1" file="shared_pseudocode.xml" hover="function: ALUExceptionReturn(bits(32) address)">ALUExceptionReturn</a>(result);
else
<a link="impl-aarch32.ALUWritePC.1" file="shared_pseudocode.xml" hover="function: ALUWritePC(bits(32) address)">ALUWritePC</a>(result);
else
<a link="impl-aarch32.R.write.1" file="shared_pseudocode.xml" hover="accessor: R[integer n] = bits(32) value">R</a>[d] = result;
if setflags then
PSTATE.&lt;N,Z,C,V&gt; = nzcv;</pstext>
</ps>
</ps_section>
</instructionsection>