<?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-2025 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="SSAT" title="SSAT -- AArch32" type="instruction">
  <docvars>
    <docvar key="instr-class" value="general"/>
    <docvar key="mnemonic" value="SSAT"/>
  </docvars>
  <heading>SSAT</heading>
  <desc>
    <brief>
      <para>Signed Saturate</para>
    </brief>
    <authored>
      <para>Signed Saturate saturates an optionally-shifted signed value to a
selectable signed range.</para>
      <para>This instruction sets <xref linkend="ARMARM_CHDEDFDC">PSTATE</xref>.Q to 1 if the
operation saturates.</para>
    </authored>
    <encodingnotes>
      <para>For more information about the <arm-defined-word>CONSTRAINED UNPREDICTABLE</arm-defined-word> behavior of this instruction, see <xref linkend="ARMARM_CJAEGDJC">Architectural Constraints on UNPREDICTABLE behaviors</xref>.</para>
    </encodingnotes>
  </desc>
  <alias_list howmany="0"/>
  <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="2" isa="A32">
      <docvars>
        <docvar key="armarmheading" value="A1"/>
        <docvar key="instr-class" value="general"/>
        <docvar key="isa" value="A32"/>
        <docvar key="mnemonic" value="SSAT"/>
      </docvars>
      <iclassintro count="2"/>
      <regdiagram form="32" psname="A32.media.sat32.SSAT_A1_ASR" 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>1</c>
          <c>1</c>
          <c>0</c>
          <c>1</c>
        </box>
        <box hibit="22" name="U" usename="1" settings="1" psbits="x">
          <c>0</c>
        </box>
        <box hibit="21" width="1" settings="1">
          <c>1</c>
        </box>
        <box hibit="20" width="5" name="sat_imm" usename="1">
          <c colspan="5"/>
        </box>
        <box hibit="15" width="4" name="Rd" usename="1">
          <c colspan="4"/>
        </box>
        <box hibit="11" width="5" name="imm5" usename="1">
          <c colspan="5"/>
        </box>
        <box hibit="6" width="1" name="sh" usename="1">
          <c colspan="1"/>
        </box>
        <box hibit="5" width="2" settings="2">
          <c>0</c>
          <c>1</c>
        </box>
        <box hibit="3" width="4" name="Rn" usename="1">
          <c colspan="4"/>
        </box>
      </regdiagram>
      <encoding name="SSAT_A1_ASR" oneofinclass="2" oneof="4" label="Arithmetic shift right" bitdiffs="sh == 1">
        <docvars>
          <docvar key="armarmheading" value="A1"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="A32"/>
          <docvar key="mnemonic-shift-type" value="SSAT-asr"/>
          <docvar key="shift-type" value="asr"/>
          <docvar key="mnemonic" value="SSAT"/>
        </docvars>
        <box hibit="6" width="1" name="sh">
          <c>1</c>
        </box>
        <asmtemplate><text>SSAT{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="cond__2">&lt;c&gt;</a><text>}{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="qw_option">&lt;q&gt;</a><text>}  </text><a hover="Is the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="Rd">&lt;Rd&gt;</a><text>, #</text><a hover="Is the bit position for saturation, in the range 1 to 32, encoded in the &quot;sat_imm&quot; field as &lt;imm&gt;-1." link="imm__93">&lt;imm&gt;</a><text>, </text><a hover="Is the general-purpose source register, encoded in the &quot;Rn&quot; field." link="Rn__8">&lt;Rn&gt;</a><text>, ASR #</text><a hover="For the &quot;A1 Arithmetic shift right&quot; variant: is the shift amount, in the range 1 to 32 encoded in the &quot;imm5&quot; field as &lt;amount&gt; modulo 32." link="amount__14">&lt;amount&gt;</a></asmtemplate>
      </encoding>
      <encoding name="SSAT_A1_LSL" oneofinclass="2" oneof="4" label="Logical shift left" bitdiffs="sh == 0">
        <docvars>
          <docvar key="armarmheading" value="A1"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="A32"/>
          <docvar key="mnemonic-shift-type" value="SSAT-lsl"/>
          <docvar key="shift-type" value="lsl"/>
          <docvar key="mnemonic" value="SSAT"/>
        </docvars>
        <box hibit="6" width="1" name="sh">
          <c>0</c>
        </box>
        <asmtemplate><text>SSAT{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="cond__2">&lt;c&gt;</a><text>}{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="qw_option">&lt;q&gt;</a><text>}  </text><a hover="Is the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="Rd">&lt;Rd&gt;</a><text>, #</text><a hover="Is the bit position for saturation, in the range 1 to 32, encoded in the &quot;sat_imm&quot; field as &lt;imm&gt;-1." link="imm__93">&lt;imm&gt;</a><text>, </text><a hover="Is the general-purpose source register, encoded in the &quot;Rn&quot; field." link="Rn__8">&lt;Rn&gt;</a><text> {, LSL #</text><a hover="For the &quot;A1 Logical shift left&quot; variant: is the optional shift amount, in the range 0 to 31, defaulting to 0 and encoded in the &quot;imm5&quot; field." link="amount__15">&lt;amount&gt;</a><text>}</text></asmtemplate>
      </encoding>
      <ps_section howmany="1">
        <ps name="A32.media.sat32.SSAT_A1_ASR" sections="1" secttype="noheading">
          <pstext mayhavelinks="1" section="Decode" rep_section="decode">let d : integer = UInt(Rd);
let n : integer = UInt(Rn);
let saturate_to : integer{} = UInt(sat_imm)+1;
let (shift_t, shift_n) : (<a link="SRType" file="shared_pseudocode.xml" hover="type SRType">SRType</a>, integer) = DecodeImmShift(sh::'0', imm5);
if d == 15 || n == 15 then UnpredictableProcedure(); end;</pstext></ps>
      </ps_section>
    </iclass>
    <iclass name="T1" oneof="2" id="iclass_t1" no_encodings="2" isa="T32">
      <docvars>
        <docvar key="armarmheading" value="T1"/>
        <docvar key="instr-class" value="general"/>
        <docvar key="isa" value="T32"/>
        <docvar key="mnemonic" value="SSAT"/>
      </docvars>
      <iclassintro count="2"/>
      <regdiagram form="16x2" psname="T32.w.imm.sat_bit.SSAT_T1_ASR">
        <box hibit="31" width="10" settings="10">
          <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>0</c>
          <c>0</c>
        </box>
        <box hibit="21" width="1" name="sh" usename="1">
          <c colspan="1"/>
        </box>
        <box hibit="20" width="1" settings="1">
          <c>0</c>
        </box>
        <box hibit="19" width="4" name="Rn" usename="1">
          <c colspan="4"/>
        </box>
        <box hibit="15" width="1" settings="1">
          <c>0</c>
        </box>
        <box hibit="14" width="3" name="imm3" usename="1">
          <c colspan="3"/>
        </box>
        <box hibit="11" width="4" name="Rd" usename="1">
          <c colspan="4"/>
        </box>
        <box hibit="7" width="2" name="imm2" usename="1">
          <c colspan="2"/>
        </box>
        <box hibit="5" width="1" settings="1">
          <c>(0)</c>
        </box>
        <box hibit="4" width="5" name="sat_imm" usename="1">
          <c colspan="5"/>
        </box>
      </regdiagram>
      <encoding name="SSAT_T1_ASR" oneofinclass="2" oneof="4" label="Arithmetic shift right" bitdiffs="sh == 1 &amp;&amp; !(imm3 == 000 &amp;&amp; imm2 == 00)">
        <docvars>
          <docvar key="armarmheading" value="T1"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="T32"/>
          <docvar key="mnemonic-shift-type" value="SSAT-asr"/>
          <docvar key="shift-type" value="asr"/>
          <docvar key="mnemonic" value="SSAT"/>
        </docvars>
        <box hibit="21" width="1" name="sh">
          <c>1</c>
        </box>
        <asmtemplate><text>SSAT{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="cond__2">&lt;c&gt;</a><text>}{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="qw_option">&lt;q&gt;</a><text>}  </text><a hover="Is the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="Rd">&lt;Rd&gt;</a><text>, #</text><a hover="Is the bit position for saturation, in the range 1 to 32, encoded in the &quot;sat_imm&quot; field as &lt;imm&gt;-1." link="imm__93">&lt;imm&gt;</a><text>, </text><a hover="Is the general-purpose source register, encoded in the &quot;Rn&quot; field." link="Rn__8">&lt;Rn&gt;</a><text>, ASR #</text><a hover="For the &quot;T1 Arithmetic shift right&quot; variant: is the shift amount, in the range 1 to 31 encoded in the &quot;imm3:imm2&quot; field as &lt;amount&gt;." link="imm3_imm2__10">&lt;amount&gt;</a></asmtemplate>
      </encoding>
      <encoding name="SSAT_T1_LSL" oneofinclass="2" oneof="4" label="Logical shift left" bitdiffs="sh == 0">
        <docvars>
          <docvar key="armarmheading" value="T1"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="T32"/>
          <docvar key="mnemonic-shift-type" value="SSAT-lsl"/>
          <docvar key="shift-type" value="lsl"/>
          <docvar key="mnemonic" value="SSAT"/>
        </docvars>
        <box hibit="21" width="1" name="sh">
          <c>0</c>
        </box>
        <asmtemplate><text>SSAT{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="cond__2">&lt;c&gt;</a><text>}{</text><a hover="See x[Standard assembler syntax fields](Babbefhf)." link="qw_option">&lt;q&gt;</a><text>}  </text><a hover="Is the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="Rd">&lt;Rd&gt;</a><text>, #</text><a hover="Is the bit position for saturation, in the range 1 to 32, encoded in the &quot;sat_imm&quot; field as &lt;imm&gt;-1." link="imm__93">&lt;imm&gt;</a><text>, </text><a hover="Is the general-purpose source register, encoded in the &quot;Rn&quot; field." link="Rn__8">&lt;Rn&gt;</a><text> {, LSL #</text><a hover="For the &quot;T1 Logical shift left&quot; variant: is the optional shift amount, in the range 0 to 31, defaulting to 0 and encoded in the &quot;imm3:imm2&quot; field." link="imm3_imm2__9">&lt;amount&gt;</a><text>}</text></asmtemplate>
      </encoding>
      <ps_section howmany="1">
        <ps name="T32.w.imm.sat_bit.SSAT_T1_ASR" sections="1" secttype="noheading">
          <pstext mayhavelinks="1" section="Decode" rep_section="decode">if sh == '1' &amp;&amp; (imm3::imm2) == '00000' then See("SSAT16"); end;
let d : integer = UInt(Rd);
let n : integer = UInt(Rn);
let saturate_to : integer{} = UInt(sat_imm)+1;
let (shift_t, shift_n) : (<a link="SRType" file="shared_pseudocode.xml" hover="type SRType">SRType</a>, integer) = DecodeImmShift(sh::'0', imm3::imm2);
// Armv8-A removes UNPREDICTABLE for R13
if d == 15 || n == 15 then UnpredictableProcedure(); end;</pstext></ps>
      </ps_section>
    </iclass>
  </classes>
  <explanations scope="all">
    <explanation enclist="SSAT_A1_ASR, SSAT_A1_LSL, SSAT_T1_ASR, SSAT_T1_LSL" symboldefcount="1">
      <symbol link="cond__2">&lt;c&gt;</symbol>
      <account encodedin="cond">
        <intro>
          <para>See <xref linkend="Babbefhf">Standard assembler syntax fields</xref>.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_ASR, SSAT_A1_LSL, SSAT_T1_ASR, SSAT_T1_LSL" symboldefcount="1">
      <symbol link="qw_option">&lt;q&gt;</symbol>
      <account encodedin="">
        <intro>
          <para>See <xref linkend="Babbefhf">Standard assembler syntax fields</xref>.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_ASR, SSAT_A1_LSL, SSAT_T1_ASR, SSAT_T1_LSL" symboldefcount="1">
      <symbol link="Rd">&lt;Rd&gt;</symbol>
      <account encodedin="Rd">
        <intro>
          <para>Is the general-purpose destination register, encoded in the "Rd" field.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_ASR, SSAT_A1_LSL, SSAT_T1_ASR, SSAT_T1_LSL" symboldefcount="1">
      <symbol link="imm__93">&lt;imm&gt;</symbol>
      <account encodedin="sat_imm">
        <intro>
          <para>Is the bit position for saturation, in the range 1 to 32, encoded in the "sat_imm" field as &lt;imm&gt;-1.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_ASR, SSAT_A1_LSL, SSAT_T1_ASR, SSAT_T1_LSL" symboldefcount="1">
      <symbol link="Rn__8">&lt;Rn&gt;</symbol>
      <account encodedin="Rn">
        <intro>
          <para>Is the general-purpose source register, encoded in the "Rn" field.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_ASR" symboldefcount="1">
      <symbol link="amount__14">&lt;amount&gt;</symbol>
      <account encodedin="imm5">
        <intro>
          <para>For the "A1 Arithmetic shift right" variant: is the shift amount, in the range 1 to 32 encoded in the "imm5" field as &lt;amount&gt; modulo 32.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_A1_LSL" symboldefcount="2">
      <symbol link="amount__15">&lt;amount&gt;</symbol>
      <account encodedin="imm5">
        <intro>
          <para>For the "A1 Logical shift left" variant: is the optional shift amount, in the range 0 to 31, defaulting to 0 and encoded in the "imm5" field.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_T1_ASR" symboldefcount="3">
      <symbol link="imm3_imm2__10">&lt;amount&gt;</symbol>
      <account encodedin="(imm3 :: imm2)">
        <intro>
          <para>For the "T1 Arithmetic shift right" variant: is the shift amount, in the range 1 to 31 encoded in the "imm3:imm2" field as &lt;amount&gt;.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="SSAT_T1_LSL" symboldefcount="4">
      <symbol link="imm3_imm2__9">&lt;amount&gt;</symbol>
      <account encodedin="(imm3 :: imm2)">
        <intro>
          <para>For the "T1 Logical shift left" variant: is the optional shift amount, in the range 0 to 31, defaulting to 0 and encoded in the "imm3:imm2" field.</para>
        </intro>
      </account>
    </explanation>
  </explanations>
  <ps_section howmany="1">
    <ps name="A32.media.sat32.SSAT_A1_ASR" sections="1" secttype="Operation">
      <pstext mayhavelinks="1" section="Execute" rep_section="execute">if ConditionPassed() then
    EncodingSpecificOperations();
    let operand : bits(32) = Shift{}(R(n), shift_t, shift_n, PSTATE.C);  // PSTATE.C ignored
    let (result, sat) : (bits(saturate_to), boolean) = SignedSatQ{saturate_to}(SInt(operand));
    R(d) = SignExtend{32}(result);
    if sat then
        PSTATE.Q = '1';
    end;
end;</pstext></ps>
  </ps_section>
  <timestamp>2026-03-12 12:23:09</timestamp>
  <commit_id>2025-09_rel_asl1</commit_id>
</instructionsection>
