Files
archived-ballistic/spec/arm64_xml/ror_extr.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

184 lines
9.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="ROR_EXTR" title="ROR (immediate) -- A64" type="alias">
<docvars>
<docvar key="alias_mnemonic" value="ROR" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="EXTR" />
<docvar key="source-type" value="src-is-immediate" />
</docvars>
<heading>ROR (immediate)</heading>
<desc>
<brief>
<para>Rotate right (immediate)</para>
</brief>
<authored>
<para>Rotate right (immediate) provides the value of the contents of a register rotated by a variable number of bits. The bits that are rotated off the right end are inserted into the vacated bit positions on the left.</para>
</authored>
</desc>
<operationalnotes>
<para>If PSTATE.DIT is 1:</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>
<aliasto refiform="extr.xml" iformid="EXTR">EXTR</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" />
<docvar key="mnemonic" value="EXTR" />
</docvars>
<iclassintro count="2"></iclassintro>
<regdiagram form="32" psname="aarch64/instrs/integer/ins-ext/extract/immediate">
<box hibit="31" name="sf" usename="1">
<c></c>
</box>
<box hibit="30" width="2" name="op21" settings="2">
<c>0</c>
<c>0</c>
</box>
<box hibit="28" width="6" settings="6">
<c>1</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>1</c>
</box>
<box hibit="22" name="N" usename="1">
<c></c>
</box>
<box hibit="21" name="o0" settings="1">
<c>0</c>
</box>
<box hibit="20" width="5" name="Rm" usename="1">
<c colspan="5"></c>
</box>
<box hibit="15" width="6" name="imms" usename="1">
<c colspan="6"></c>
</box>
<box hibit="9" width="5" name="Rn" usename="1">
<c colspan="5"></c>
</box>
<box hibit="4" width="5" name="Rd" usename="1">
<c colspan="5"></c>
</box>
</regdiagram>
<encoding name="ROR_EXTR_32_extract" oneofinclass="2" oneof="2" label="32-bit" bitdiffs="sf == 0 &amp;&amp; N == 0 &amp;&amp; imms == 0xxxxx">
<docvars>
<docvar key="alias_mnemonic" value="ROR" />
<docvar key="datatype" value="32" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="EXTR" />
<docvar key="source-type" value="src-is-immediate" />
</docvars>
<box hibit="31" width="1" name="sf">
<c>0</c>
</box>
<box hibit="22" width="1" name="N">
<c>0</c>
</box>
<box hibit="15" width="6" name="imms">
<c>0</c>
<c></c>
<c></c>
<c></c>
<c></c>
<c></c>
</box>
<asmtemplate><text>ROR </text><a link="sa_wd" hover="32-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Wd&gt;</a><text>, </text><a link="sa_ws" hover="32-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Ws&gt;</a><text>, #</text><a link="sa_shift" hover="Amount by which to rotate [0-31] (field &quot;imms&quot;)">&lt;shift&gt;</a></asmtemplate>
<equivalent_to>
<asmtemplate><a href="extr.xml#EXTR_32_extract">EXTR</a><text> </text><a link="sa_wd" hover="32-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Wd&gt;</a><text>, </text><a link="sa_ws" hover="32-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Ws&gt;</a><text>, </text><a link="sa_ws" hover="32-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Ws&gt;</a><text>, #</text><a link="sa_shift" hover="Amount by which to rotate [0-31] (field &quot;imms&quot;)">&lt;shift&gt;</a></asmtemplate>
<aliascond>Rn == Rm</aliascond>
</equivalent_to>
</encoding>
<encoding name="ROR_EXTR_64_extract" oneofinclass="2" oneof="2" label="64-bit" bitdiffs="sf == 1 &amp;&amp; N == 1">
<docvars>
<docvar key="alias_mnemonic" value="ROR" />
<docvar key="datatype" value="64" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="EXTR" />
<docvar key="source-type" value="src-is-immediate" />
</docvars>
<box hibit="31" width="1" name="sf">
<c>1</c>
</box>
<box hibit="22" width="1" name="N">
<c>1</c>
</box>
<asmtemplate><text>ROR </text><a link="sa_xd" hover="64-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Xd&gt;</a><text>, </text><a link="sa_xs" hover="64-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Xs&gt;</a><text>, #</text><a link="sa_shift_1" hover="Amount by which to rotate [0-63] (field &quot;imms&quot;)">&lt;shift&gt;</a></asmtemplate>
<equivalent_to>
<asmtemplate><a href="extr.xml#EXTR_64_extract">EXTR</a><text> </text><a link="sa_xd" hover="64-bit general-purpose destination register (field &quot;Rd&quot;)">&lt;Xd&gt;</a><text>, </text><a link="sa_xs" hover="64-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Xs&gt;</a><text>, </text><a link="sa_xs" hover="64-bit general-purpose source register (field &quot;Rn&quot; and &quot;Rm&quot;)">&lt;Xs&gt;</a><text>, #</text><a link="sa_shift_1" hover="Amount by which to rotate [0-63] (field &quot;imms&quot;)">&lt;shift&gt;</a></asmtemplate>
<aliascond>Rn == Rm</aliascond>
</equivalent_to>
</encoding>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="ROR_EXTR_32_extract" symboldefcount="1">
<symbol link="sa_wd">&lt;Wd&gt;</symbol>
<account encodedin="Rd">
<intro>
<para>Is the 32-bit name of the general-purpose destination register, encoded in the "Rd" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="ROR_EXTR_32_extract" symboldefcount="1">
<symbol link="sa_ws">&lt;Ws&gt;</symbol>
<account encodedin="Rm:Rn">
<intro>
<para>Is the 32-bit name of the general-purpose source register, encoded in the "Rn" and "Rm" fields.</para>
</intro>
</account>
</explanation>
<explanation enclist="ROR_EXTR_64_extract" symboldefcount="1">
<symbol link="sa_xd">&lt;Xd&gt;</symbol>
<account encodedin="Rd">
<intro>
<para>Is the 64-bit name of the general-purpose destination register, encoded in the "Rd" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="ROR_EXTR_64_extract" symboldefcount="1">
<symbol link="sa_xs">&lt;Xs&gt;</symbol>
<account encodedin="Rm:Rn">
<intro>
<para>Is the 64-bit name of the general-purpose source register, encoded in the "Rn" and "Rm" fields.</para>
</intro>
</account>
</explanation>
<explanation enclist="ROR_EXTR_32_extract" symboldefcount="1">
<symbol link="sa_shift">&lt;shift&gt;</symbol>
<account encodedin="imms">
<docvars>
<docvar key="datatype" value="32" />
</docvars>
<intro>
<para>For the 32-bit variant: is the amount by which to rotate, in the range 0 to 31, encoded in the "imms" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="ROR_EXTR_64_extract" symboldefcount="2">
<symbol link="sa_shift_1">&lt;shift&gt;</symbol>
<account encodedin="imms">
<docvars>
<docvar key="datatype" value="64" />
</docvars>
<intro>
<para>For the 64-bit variant: is the amount by which to rotate, in the range 0 to 63, encoded in the "imms" field.</para>
</intro>
</account>
</explanation>
</explanations>
</instructionsection>