slonik/specs/ldrex.xml

243 lines
12 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="LDREX" title="LDREX -- AArch32" type="instruction">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="mnemonic" value="LDREX" />
</docvars>
<heading>LDREX</heading>
<desc>
<brief>
<para>Load Register Exclusive</para>
</brief>
<authored>
<para>Load Register Exclusive calculates an address from a base register value and an immediate offset, loads a word from memory, writes it to a register and:</para>
<list type="unordered">
<listitem><content>If the address has the Shared Memory attribute, marks the physical address as exclusive access for the executing PE in a global monitor.</content></listitem>
<listitem><content>Causes the executing PE to indicate an active exclusive access in the local monitor.</content></listitem>
</list>
<para>For more information about support for shared memory see <xref linkend="CEGDAEAG">Synchronization and semaphores</xref>. For information about memory accesses see <xref linkend="Chddjfjf">Memory accesses</xref>.</para>
</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>.</para>
</encodingnotes>
</desc>
<operationalnotes>
<para>If CPSR.DIT is 1, the timing of this instruction is insensitive to the value of the data being loaded or stored.</para>
</operationalnotes>
<alias_list howmany="0"></alias_list>
<classes>
<classesintro count="2">
<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>
<txt>.</txt>
</classesintro>
<iclass name="A1" oneof="2" id="iclass_a1" no_encodings="1" isa="A32">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="LDREX" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="32" psname="aarch32/instrs/LDREX/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="5" settings="5">
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="22" width="2" name="size" settings="2">
<c>0</c>
<c>0</c>
</box>
<box hibit="20" name="L" settings="1">
<c>1</c>
</box>
<box hibit="19" width="4" name="Rn" usename="1">
<c colspan="4"></c>
</box>
<box hibit="15" width="4" name="Rt" usename="1">
<c colspan="4"></c>
</box>
<box hibit="11" settings="1">
<c>(1)</c>
</box>
<box hibit="10" settings="1">
<c>(1)</c>
</box>
<box hibit="9" name="ex" settings="1">
<c>1</c>
</box>
<box hibit="8" name="ord" settings="1">
<c>1</c>
</box>
<box hibit="7" width="4" settings="4">
<c>1</c>
<c>0</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="3" width="4" name="xRt" settings="4">
<c>(1)</c>
<c>(1)</c>
<c>(1)</c>
<c>(1)</c>
</box>
</regdiagram>
<encoding name="LDREX_A1" oneofinclass="1" oneof="2" label="A1">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="LDREX" />
</docvars>
<asmtemplate><text>LDREX</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><a link="sa_rt" hover="General-purpose register to be transferred (field &quot;Rt&quot;)">&lt;Rt&gt;</a><text>, [</text><a link="sa_rn" hover="General-purpose base register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text> </text><text>{</text><text>, </text><a>{#}</a><a link="sa_imm_1" hover="The immediate offset added to the value of {syntax{&lt;Rn&gt;}} to calculate the address">&lt;imm&gt;</a><text>}</text><text>]</text></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/LDREX/A1_A.txt" mylink="aarch32.instrs.LDREX.A1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">t = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rt); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); imm32 = <a link="impl-shared.Zeros.1" file="shared_pseudocode.xml" hover="function: bits(N) Zeros(integer N)">Zeros</a>(32); // Zero offset
if t == 15 || n == 15 then UNPREDICTABLE;</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T1" oneof="2" 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="LDREX" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="16x2" psname="aarch32/instrs/LDREX/T1_A.txt">
<box hibit="31" width="11" settings="11">
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="20" name="L" settings="1">
<c>1</c>
</box>
<box hibit="19" width="4" name="Rn" usename="1">
<c colspan="4"></c>
</box>
<box hibit="15" width="4" name="Rt" usename="1">
<c colspan="4"></c>
</box>
<box hibit="11" width="4" name="Rd" settings="4">
<c>(1)</c>
<c>(1)</c>
<c>(1)</c>
<c>(1)</c>
</box>
<box hibit="7" width="8" name="imm8" usename="1">
<c colspan="8"></c>
</box>
</regdiagram>
<encoding name="LDREX_T1" oneofinclass="1" oneof="2" label="T1">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="LDREX" />
</docvars>
<asmtemplate><text>LDREX</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><a link="sa_rt" hover="General-purpose register to be transferred (field &quot;Rt&quot;)">&lt;Rt&gt;</a><text>, [</text><a link="sa_rn" hover="General-purpose base register (field &quot;Rn&quot;)">&lt;Rn&gt;</a><text> </text><text>{</text><text>, #</text><a link="sa_imm" hover="The immediate offset added to the value of {syntax{&lt;Rn&gt;}} to calculate the address">&lt;imm&gt;</a><text>}</text><text>]</text></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/LDREX/T1_A.txt" mylink="aarch32.instrs.LDREX.T1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">t = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rt); n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn); imm32 = <a link="impl-shared.ZeroExtend.2" file="shared_pseudocode.xml" hover="function: bits(N) ZeroExtend(bits(M) x, integer N)">ZeroExtend</a>(imm8:'00', 32);
if t == 15 || n == 15 then UNPREDICTABLE; // Armv8-A removes UNPREDICTABLE for R13</pstext>
</ps>
</ps_section>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="LDREX_A1, LDREX_T1" 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="LDREX_A1, LDREX_T1" 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="LDREX_A1, LDREX_T1" symboldefcount="1">
<symbol link="sa_rt">&lt;Rt&gt;</symbol>
<account encodedin="Rt">
<intro>
<para>Is the general-purpose register to be transferred, encoded in the "Rt" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="LDREX_A1, LDREX_T1" symboldefcount="1">
<symbol link="sa_rn">&lt;Rn&gt;</symbol>
<account encodedin="Rn">
<intro>
<para>Is the general-purpose base register, encoded in the "Rn" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="LDREX_A1" symboldefcount="1">
<symbol link="sa_imm_1">&lt;imm&gt;</symbol>
<account encodedin="">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="isa" value="A32" />
</docvars>
<intro>
<para>For encoding A1: the immediate offset added to the value of <syntax>&lt;Rn&gt;</syntax> to calculate the address. <syntax>&lt;imm&gt;</syntax> can only be 0 or omitted.</para>
</intro>
</account>
</explanation>
<explanation enclist="LDREX_T1" symboldefcount="2">
<symbol link="sa_imm">&lt;imm&gt;</symbol>
<account encodedin="">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="isa" value="T32" />
</docvars>
<intro>
<para>For encoding T1: the immediate offset added to the value of <syntax>&lt;Rn&gt;</syntax> to calculate the address. <syntax>&lt;imm&gt;</syntax> can be omitted, meaning an offset of 0. Values are multiples of 4 in the range 0-1020.</para>
</intro>
</account>
</explanation>
</explanations>
<ps_section howmany="1">
<ps name="aarch32/instrs/LDREX/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();
address = <a link="impl-aarch32.R.read.1" file="shared_pseudocode.xml" hover="accessor: bits(32) R[integer n]">R</a>[n] + imm32;
<a link="AArch32.SetExclusiveMonitors.2" file="shared_pseudocode.xml" hover="function: AArch32.SetExclusiveMonitors(bits(32) address, integer size)">AArch32.SetExclusiveMonitors</a>(address,4);
<a link="impl-aarch32.R.write.1" file="shared_pseudocode.xml" hover="accessor: R[integer n] = bits(32) value">R</a>[t] = <a link="impl-aarch32.MemA.read.2" file="shared_pseudocode.xml" hover="accessor: bits(8*size) MemA[bits(32) address, integer size]">MemA</a>[address,4];</pstext>
</ps>
</ps_section>
</instructionsection>