Files
archived-ballistic/spec/arm64_xml/stclrh_ldclrh.xml
Ronald Caesar 26a677f8b4 decoder: Add ARM specification docs
Signed-off-by: Ronald Caesar <github43132@proton.me>
2025-12-12 18:11:36 -04:00

147 lines
7.2 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="STCLRH_LDCLRH" title="STCLRH, STCLRLH -- A64" type="alias">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
</docvars>
<heading>STCLRH, STCLRLH</heading>
<desc>
<brief>
<para>Atomic bit clear on halfword in memory, without return</para>
</brief>
<authored>
<para>Atomic bit clear on halfword in memory, without return, atomically loads a 16-bit halfword from memory, performs a bitwise AND with the complement of the value held in a register on it, and stores the result back to memory.</para>
<list type="unordered">
<listitem><content><instruction>STCLRH</instruction> does not have release semantics.</content></listitem>
<listitem><content><instruction>STCLRLH</instruction> stores to memory with release semantics, as described in <xref linkend="BEIHCHEF">Load-Acquire, Store-Release</xref>.</content></listitem>
</list>
<para>For information about memory accesses see <xref linkend="CHDIIIBB">Load/Store addressing modes</xref>.</para>
</authored>
</desc>
<operationalnotes>
<para>If PSTATE.DIT is 1, the timing of this instruction is insensitive to the value of the data being loaded or stored.</para>
</operationalnotes>
<aliasto refiform="ldclrh.xml" iformid="LDCLRH">LDCLRH, LDCLRAH, LDCLRALH, LDCLRLH</aliasto>
<classes>
<iclass name="Integer" oneof="1" id="iclass_general" no_encodings="2" isa="A64">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
</docvars>
<iclassintro count="2"></iclassintro>
<arch_variants>
<arch_variant name="ARMv8.1" feature="FEAT_LSE" />
</arch_variants>
<regdiagram form="32" psname="aarch64/instrs/memory/atomicops/ld" tworows="1">
<box hibit="31" width="2" name="size" usename="1" settings="2" psbits="xx">
<c>0</c>
<c>1</c>
</box>
<box hibit="29" width="3" settings="3">
<c>1</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="26" name="V" settings="1">
<c>0</c>
</box>
<box hibit="25" width="2" settings="2">
<c>0</c>
<c>0</c>
</box>
<box hibit="23" name="A" usename="1" settings="1" psbits="x">
<c>0</c>
</box>
<box hibit="22" name="R" usename="1">
<c></c>
</box>
<box hibit="21" settings="1">
<c>1</c>
</box>
<box hibit="20" width="5" name="Rs" usename="1">
<c colspan="5"></c>
</box>
<box hibit="15" name="o3" settings="1">
<c>0</c>
</box>
<box hibit="14" width="3" name="opc" usename="1" settings="3" psbits="xxx">
<c>0</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="11" width="2" settings="2">
<c>0</c>
<c>0</c>
</box>
<box hibit="9" width="5" name="Rn" usename="1">
<c colspan="5"></c>
</box>
<box hibit="4" width="5" name="Rt" usename="1" settings="5" psbits="xxxxx">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
</box>
</regdiagram>
<encoding name="STCLRH_LDCLRH_32_memop" oneofinclass="2" oneof="2" label="No memory ordering" bitdiffs="R == 0">
<docvars>
<docvar key="alias_mnemonic" value="STCLRH" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="loadstore-order" value="no-order" />
<docvar key="mnemonic" value="LDCLRH" />
</docvars>
<box hibit="22" width="1" name="R">
<c>0</c>
</box>
<asmtemplate><text>STCLRH </text><a link="sa_ws" hover="32-bit general-purpose register holding data value to be operated on with the contents of memory location (field &quot;Rs&quot;)">&lt;Ws&gt;</a><text>, [</text><a link="sa_xn_sp" hover="64-bit general-purpose base register or SP (field &quot;Rn&quot;)">&lt;Xn|SP&gt;</a><text>]</text></asmtemplate>
<equivalent_to>
<asmtemplate><a href="ldclrh.xml#LDCLRH_32_memop">LDCLRH</a><text> </text><a link="sa_ws" hover="32-bit general-purpose register holding data value to be operated on with the contents of memory location (field &quot;Rs&quot;)">&lt;Ws&gt;</a><text>, WZR, [</text><a link="sa_xn_sp" hover="64-bit general-purpose base register or SP (field &quot;Rn&quot;)">&lt;Xn|SP&gt;</a><text>]</text></asmtemplate>
<aliascond>Unconditionally</aliascond>
</equivalent_to>
</encoding>
<encoding name="STCLRLH_LDCLRLH_32_memop" oneofinclass="2" oneof="2" label="Release" bitdiffs="R == 1">
<docvars>
<docvar key="alias_mnemonic" value="STCLRLH" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="loadstore-order" value="release" />
<docvar key="mnemonic" value="LDCLRLH" />
</docvars>
<box hibit="22" width="1" name="R">
<c>1</c>
</box>
<asmtemplate><text>STCLRLH </text><a link="sa_ws" hover="32-bit general-purpose register holding data value to be operated on with the contents of memory location (field &quot;Rs&quot;)">&lt;Ws&gt;</a><text>, [</text><a link="sa_xn_sp" hover="64-bit general-purpose base register or SP (field &quot;Rn&quot;)">&lt;Xn|SP&gt;</a><text>]</text></asmtemplate>
<equivalent_to>
<asmtemplate><a href="ldclrh.xml#LDCLRLH_32_memop">LDCLRLH</a><text> </text><a link="sa_ws" hover="32-bit general-purpose register holding data value to be operated on with the contents of memory location (field &quot;Rs&quot;)">&lt;Ws&gt;</a><text>, WZR, [</text><a link="sa_xn_sp" hover="64-bit general-purpose base register or SP (field &quot;Rn&quot;)">&lt;Xn|SP&gt;</a><text>]</text></asmtemplate>
<aliascond>Unconditionally</aliascond>
</equivalent_to>
</encoding>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="STCLRH_LDCLRH_32_memop" symboldefcount="1">
<symbol link="sa_ws">&lt;Ws&gt;</symbol>
<account encodedin="Rs">
<intro>
<para>Is the 32-bit name of the general-purpose register holding the data value to be operated on with the contents of the memory location, encoded in the "Rs" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="STCLRH_LDCLRH_32_memop" symboldefcount="1">
<symbol link="sa_xn_sp">&lt;Xn|SP&gt;</symbol>
<account encodedin="Rn">
<intro>
<para>Is the 64-bit name of the general-purpose base register or stack pointer, encoded in the "Rn" field.</para>
</intro>
</account>
</explanation>
</explanations>
</instructionsection>