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

366 lines
18 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="UQRSHL_advsimd" title="UQRSHL -- A64" type="instruction">
<docvars>
<docvar key="instr-class" value="advsimd" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="UQRSHL" />
</docvars>
<heading>UQRSHL</heading>
<desc>
<brief>
<para>Unsigned saturating Rounding Shift Left (register)</para>
</brief>
<authored>
<para>Unsigned saturating Rounding Shift Left (register). This instruction takes each vector element of the first source SIMD&amp;FP register, shifts the vector element by a value from the least significant byte of the corresponding vector element of the second source SIMD&amp;FP register, places the results into a vector, and writes the vector to the destination SIMD&amp;FP register.</para>
<para>If the shift value is positive, the operation is a left shift. Otherwise, it is a right shift. The results are rounded. For truncated results, see <xref linkend="A64.instructions.UQSHL_advsimd_imm">UQSHL</xref>.</para>
<para>If overflow occurs with any of the results, those results are saturated. If saturation occurs, the cumulative saturation bit <xref linkend="AArch64.fpsr">FPSR</xref>.QC is set.</para>
<para>Depending on the settings in the <xref linkend="AArch64.cpacr_el1">CPACR_EL1</xref>, <xref linkend="AArch64.cptr_el2">CPTR_EL2</xref>, and <xref linkend="AArch64.cptr_el3">CPTR_EL3</xref> registers, and the current Security state and Exception level, an attempt to execute the instruction might be trapped.</para>
</authored>
</desc>
<alias_list howmany="0"></alias_list>
<classes>
<classesintro count="2">
<txt>It has encodings from 2 classes:</txt>
<a href="#iclass_sisd">Scalar</a>
<txt> and </txt>
<a href="#iclass_simd">Vector</a>
</classesintro>
<iclass name="Scalar" oneof="2" id="iclass_sisd" no_encodings="1" isa="A64">
<docvars>
<docvar key="advsimd-type" value="sisd" />
<docvar key="instr-class" value="advsimd" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="UQRSHL" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="32" psname="aarch64/instrs/vector/arithmetic/binary/uniform/shift/sisd" tworows="1">
<box hibit="31" width="2" settings="2">
<c>0</c>
<c>1</c>
</box>
<box hibit="29" name="U" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="28" width="5" settings="5">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="23" width="2" name="size" usename="1">
<c colspan="2"></c>
</box>
<box hibit="21" settings="1">
<c>1</c>
</box>
<box hibit="20" width="5" name="Rm" usename="1">
<c colspan="5"></c>
</box>
<box hibit="15" width="3" name="opcode[4:2]" settings="3">
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="12" name="R" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="11" name="S" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="10" settings="1">
<c>1</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="UQRSHL_asisdsame_only" oneofinclass="1" oneof="2" label="">
<docvars>
<docvar key="advsimd-type" value="sisd" />
<docvar key="instr-class" value="advsimd" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="UQRSHL" />
</docvars>
<asmtemplate><text>UQRSHL </text><a link="sa_v" hover="Width specifier (field &quot;size&quot;) [B,D,H,S]">&lt;V&gt;</a><a link="sa_d" hover="SIMD&amp;FP destination register number (field &quot;Rd&quot;)">&lt;d&gt;</a><text>, </text><a link="sa_v" hover="Width specifier (field &quot;size&quot;) [B,D,H,S]">&lt;V&gt;</a><a link="sa_n" hover="First SIMD&amp;FP source register number (field &quot;Rn&quot;)">&lt;n&gt;</a><text>, </text><a link="sa_v" hover="Width specifier (field &quot;size&quot;) [B,D,H,S]">&lt;V&gt;</a><a link="sa_m" hover="Second SIMD&amp;FP source register number (field &quot;Rm&quot;)">&lt;m&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch64/instrs/vector/arithmetic/binary/uniform/shift/sisd" mylink="aarch64.instrs.vector.arithmetic.binary.uniform.shift.sisd" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">integer d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd);
integer n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn);
integer m = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rm);
integer esize = 8 &lt;&lt; <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(size);
integer datasize = esize;
integer elements = 1;
boolean unsigned = (U == '1');
boolean rounding = (R == '1');
boolean saturating = (S == '1');
if S == '0' &amp;&amp; size != '11' then UNDEFINED;</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="Vector" oneof="2" id="iclass_simd" no_encodings="1" isa="A64">
<docvars>
<docvar key="advsimd-reguse" value="3reg-same" />
<docvar key="advsimd-type" value="simd" />
<docvar key="instr-class" value="advsimd" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="UQRSHL" />
</docvars>
<iclassintro count="1"></iclassintro>
<regdiagram form="32" psname="aarch64/instrs/vector/arithmetic/binary/uniform/shift/simd" tworows="1">
<box hibit="31" settings="1">
<c>0</c>
</box>
<box hibit="30" name="Q" usename="1">
<c></c>
</box>
<box hibit="29" name="U" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="28" width="5" settings="5">
<c>0</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="23" width="2" name="size" usename="1">
<c colspan="2"></c>
</box>
<box hibit="21" settings="1">
<c>1</c>
</box>
<box hibit="20" width="5" name="Rm" usename="1">
<c colspan="5"></c>
</box>
<box hibit="15" width="3" name="opcode[4:2]" settings="3">
<c>0</c>
<c>1</c>
<c>0</c>
</box>
<box hibit="12" name="R" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="11" name="S" usename="1" settings="1" psbits="x">
<c>1</c>
</box>
<box hibit="10" settings="1">
<c>1</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="UQRSHL_asimdsame_only" oneofinclass="1" oneof="2" label="">
<docvars>
<docvar key="advsimd-reguse" value="3reg-same" />
<docvar key="advsimd-type" value="simd" />
<docvar key="instr-class" value="advsimd" />
<docvar key="isa" value="A64" />
<docvar key="mnemonic" value="UQRSHL" />
</docvars>
<asmtemplate><text>UQRSHL </text><a link="sa_vd" hover="SIMD&amp;FP destination register (field &quot;Rd&quot;)">&lt;Vd&gt;</a><text>.</text><a link="sa_t" hover="Arrangement specifier (field &quot;size:Q&quot;) [2D,2S,4H,4S,8B,8H,16B]">&lt;T&gt;</a><text>, </text><a link="sa_vn" hover="First SIMD&amp;FP source register (field &quot;Rn&quot;)">&lt;Vn&gt;</a><text>.</text><a link="sa_t" hover="Arrangement specifier (field &quot;size:Q&quot;) [2D,2S,4H,4S,8B,8H,16B]">&lt;T&gt;</a><text>, </text><a link="sa_vm" hover="Second SIMD&amp;FP source register (field &quot;Rm&quot;)">&lt;Vm&gt;</a><text>.</text><a link="sa_t" hover="Arrangement specifier (field &quot;size:Q&quot;) [2D,2S,4H,4S,8B,8H,16B]">&lt;T&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch64/instrs/vector/arithmetic/binary/uniform/shift/simd" mylink="aarch64.instrs.vector.arithmetic.binary.uniform.shift.simd" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">integer d = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rd);
integer n = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rn);
integer m = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(Rm);
if size:Q == '110' then UNDEFINED;
integer esize = 8 &lt;&lt; <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(size);
integer datasize = if Q == '1' then 128 else 64;
integer elements = datasize DIV esize;
boolean unsigned = (U == '1');
boolean rounding = (R == '1');
boolean saturating = (S == '1');</pstext>
</ps>
</ps_section>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="UQRSHL_asisdsame_only" symboldefcount="1">
<symbol link="sa_v">&lt;V&gt;</symbol>
<definition encodedin="size">
<intro>Is a width specifier, </intro>
<table class="valuetable">
<tgroup cols="2">
<thead>
<row>
<entry class="bitfield">size</entry>
<entry class="symbol">&lt;V&gt;</entry>
</row>
</thead>
<tbody>
<row>
<entry class="bitfield">00</entry>
<entry class="symbol">B</entry>
</row>
<row>
<entry class="bitfield">01</entry>
<entry class="symbol">H</entry>
</row>
<row>
<entry class="bitfield">10</entry>
<entry class="symbol">S</entry>
</row>
<row>
<entry class="bitfield">11</entry>
<entry class="symbol">D</entry>
</row>
</tbody>
</tgroup>
</table>
</definition>
</explanation>
<explanation enclist="UQRSHL_asisdsame_only" symboldefcount="1">
<symbol link="sa_d">&lt;d&gt;</symbol>
<account encodedin="Rd">
<intro>
<para>Is the number of the SIMD&amp;FP destination register, in the "Rd" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="UQRSHL_asisdsame_only" symboldefcount="1">
<symbol link="sa_n">&lt;n&gt;</symbol>
<account encodedin="Rn">
<intro>
<para>Is the number of the first SIMD&amp;FP source register, encoded in the "Rn" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="UQRSHL_asisdsame_only" symboldefcount="1">
<symbol link="sa_m">&lt;m&gt;</symbol>
<account encodedin="Rm">
<intro>
<para>Is the number of the second SIMD&amp;FP source register, encoded in the "Rm" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="UQRSHL_asimdsame_only" symboldefcount="1">
<symbol link="sa_vd">&lt;Vd&gt;</symbol>
<account encodedin="Rd">
<intro>
<para>Is the name of the SIMD&amp;FP destination register, encoded in the "Rd" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="UQRSHL_asimdsame_only" symboldefcount="1">
<symbol link="sa_t">&lt;T&gt;</symbol>
<definition encodedin="size:Q">
<intro>Is an arrangement specifier, </intro>
<table class="valuetable">
<tgroup cols="3">
<thead>
<row>
<entry class="bitfield">size</entry>
<entry class="bitfield">Q</entry>
<entry class="symbol">&lt;T&gt;</entry>
</row>
</thead>
<tbody>
<row>
<entry class="bitfield">00</entry>
<entry class="bitfield">0</entry>
<entry class="symbol">8B</entry>
</row>
<row>
<entry class="bitfield">00</entry>
<entry class="bitfield">1</entry>
<entry class="symbol">16B</entry>
</row>
<row>
<entry class="bitfield">01</entry>
<entry class="bitfield">0</entry>
<entry class="symbol">4H</entry>
</row>
<row>
<entry class="bitfield">01</entry>
<entry class="bitfield">1</entry>
<entry class="symbol">8H</entry>
</row>
<row>
<entry class="bitfield">10</entry>
<entry class="bitfield">0</entry>
<entry class="symbol">2S</entry>
</row>
<row>
<entry class="bitfield">10</entry>
<entry class="bitfield">1</entry>
<entry class="symbol">4S</entry>
</row>
<row>
<entry class="bitfield">11</entry>
<entry class="bitfield">0</entry>
<entry class="symbol">RESERVED</entry>
</row>
<row>
<entry class="bitfield">11</entry>
<entry class="bitfield">1</entry>
<entry class="symbol">2D</entry>
</row>
</tbody>
</tgroup>
</table>
</definition>
</explanation>
<explanation enclist="UQRSHL_asimdsame_only" symboldefcount="1">
<symbol link="sa_vn">&lt;Vn&gt;</symbol>
<account encodedin="Rn">
<intro>
<para>Is the name of the first SIMD&amp;FP source register, encoded in the "Rn" field.</para>
</intro>
</account>
</explanation>
<explanation enclist="UQRSHL_asimdsame_only" symboldefcount="1">
<symbol link="sa_vm">&lt;Vm&gt;</symbol>
<account encodedin="Rm">
<intro>
<para>Is the name of the second SIMD&amp;FP source register, encoded in the "Rm" field.</para>
</intro>
</account>
</explanation>
</explanations>
<ps_section howmany="1">
<ps name="aarch64/instrs/vector/arithmetic/binary/uniform/shift/sisd" mylink="execute" enclabels="" sections="1" secttype="Operation">
<pstext mayhavelinks="1" section="Execute" rep_section="execute"><a link="impl-aarch64.CheckFPAdvSIMDEnabled64.0" file="shared_pseudocode.xml" hover="function: CheckFPAdvSIMDEnabled64()">CheckFPAdvSIMDEnabled64</a>();
bits(datasize) operand1 = <a link="impl-aarch64.V.read.2" file="shared_pseudocode.xml" hover="accessor: bits(width) V[integer n, integer width]">V</a>[n, datasize];
bits(datasize) operand2 = <a link="impl-aarch64.V.read.2" file="shared_pseudocode.xml" hover="accessor: bits(width) V[integer n, integer width]">V</a>[m, datasize];
bits(datasize) result;
boolean sat;
for e = 0 to elements-1
integer element = <a link="impl-shared.Int.2" file="shared_pseudocode.xml" hover="function: integer Int(bits(N) x, boolean unsigned)">Int</a>(<a link="impl-shared.Elem.read.3" file="shared_pseudocode.xml" hover="accessor: bits(size) Elem[bits(N) vector, integer e, integer size]">Elem</a>[operand1, e, esize], unsigned);
integer shift = <a link="impl-shared.SInt.1" file="shared_pseudocode.xml" hover="function: integer SInt(bits(N) x)">SInt</a>(<a link="impl-shared.Elem.read.3" file="shared_pseudocode.xml" hover="accessor: bits(size) Elem[bits(N) vector, integer e, integer size]">Elem</a>[operand2, e, esize]&lt;7:0&gt;);
if shift &gt;= 0 then // left shift
element = element &lt;&lt; shift;
else // right shift
shift = -shift;
if rounding then
element = (element + (1 &lt;&lt; (shift - 1))) &gt;&gt; shift;
else
element = element &gt;&gt; shift;
if saturating then
(<a link="impl-shared.Elem.write.3" file="shared_pseudocode.xml" hover="accessor: Elem[bits(N) &amp;vector, integer e, integer size] = bits(size) value">Elem</a>[result, e, esize], sat) = <a link="impl-shared.SatQ.3" file="shared_pseudocode.xml" hover="function: (bits(N), boolean) SatQ(integer i, integer N, boolean unsigned)">SatQ</a>(element, esize, unsigned);
if sat then FPSR.QC = '1';
else
<a link="impl-shared.Elem.write.3" file="shared_pseudocode.xml" hover="accessor: Elem[bits(N) &amp;vector, integer e, integer size] = bits(size) value">Elem</a>[result, e, esize] = element&lt;esize-1:0&gt;;
<a link="impl-aarch64.V.write.2" file="shared_pseudocode.xml" hover="accessor: V[integer n, integer width] = bits(width) value">V</a>[d, datasize] = result;</pstext>
</ps>
</ps_section>
</instructionsection>