<?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="UBFX_UBFM" title="UBFX -- A64" type="alias">
  <docvars>
    <docvar key="alias_mnemonic" value="UBFX"/>
    <docvar key="bitfield-fill" value="zero-fill"/>
    <docvar key="instr-class" value="general"/>
    <docvar key="isa" value="A64"/>
    <docvar key="mnemonic" value="UBFM"/>
  </docvars>
  <heading>UBFX</heading>
  <desc>
    <brief>
      <para>Unsigned bitfield extract</para>
    </brief>
    <authored>
      <para>This instruction copies a bitfield of <syntax>&lt;width&gt;</syntax>
bits starting from bit position <syntax>&lt;lsb&gt;</syntax> in the source
register to the least significant bits of the destination register,
and sets destination bits above the bitfield to zero.</para>
    </authored>
  </desc>
  <operationalnotes/>
  <aliasto refiform="ubfm.xml" iformid="UBFM">UBFM</aliasto>
  <classes>
    <iclass name="With zeros to left and right" oneof="1" id="iclass_with_zeros_to_left_and_right" no_encodings="2" isa="A64">
      <docvars>
        <docvar key="bitfield-fill" value="zero-fill"/>
        <docvar key="instr-class" value="general"/>
        <docvar key="isa" value="A64"/>
        <docvar key="mnemonic" value="UBFM"/>
      </docvars>
      <iclassintro count="2"/>
      <regdiagram form="32" psname="A64.dpimm.bitfield.UBFM_32M_bitfield.UBFX" tworows="1">
        <box hibit="31" width="1" name="sf" usename="1">
          <c colspan="1"/>
        </box>
        <box hibit="30" width="2" name="opc" usename="1" settings="2" psbits="xx">
          <c>1</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>0</c>
        </box>
        <box hibit="22" width="1" name="N" usename="1">
          <c colspan="1"/>
        </box>
        <box hibit="21" width="6" name="immr" usename="1">
          <c colspan="6"/>
        </box>
        <box hibit="15" width="6" name="imms" usename="1">
          <c colspan="6"/>
        </box>
        <box hibit="9" width="5" name="Rn" usename="1">
          <c colspan="5"/>
        </box>
        <box hibit="4" width="5" name="Rd" usename="1">
          <c colspan="5"/>
        </box>
      </regdiagram>
      <encoding name="UBFX_UBFM_32M_bitfield" oneofinclass="2" oneof="2" label="32-bit" bitdiffs="sf == 0 &amp;&amp; N == 0">
        <docvars>
          <docvar key="bitfield-fill" value="zero-fill"/>
          <docvar key="datatype" value="32"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="A64"/>
          <docvar key="mnemonic" value="UBFM"/>
          <docvar key="alias_mnemonic" value="UBFX"/>
        </docvars>
        <box hibit="31" width="1" name="sf">
          <c>0</c>
        </box>
        <box hibit="22" width="1" name="N">
          <c>0</c>
        </box>
        <asmtemplate><text>UBFX  </text><a hover="Is the 32-bit name of the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="WdOrWZR">&lt;Wd&gt;</a><text>, </text><a hover="Is the 32-bit name of the general-purpose source register, encoded in the &quot;Rn&quot; field." link="WnOrWZR">&lt;Wn&gt;</a><text>, #</text><a hover="For the &quot;32-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 31." link="lsb__2">&lt;lsb&gt;</a><text>, #</text><a hover="For the &quot;32-bit&quot; variant: is the width of the bitfield, in the range 1 to 32-&lt;lsb&gt;." link="width">&lt;width&gt;</a></asmtemplate>
        <equivalent_to>
          <asmtemplate><a href="ubfm.xml#UBFM_32M_bitfield">UBFM</a><text>  </text><a hover="Is the 32-bit name of the general-purpose destination register, encoded in the &quot;Rd&quot; field." href="ubfm.xml#WdOrWZR">&lt;Wd&gt;</a><text>, </text><a hover="Is the 32-bit name of the general-purpose source register, encoded in the &quot;Rn&quot; field." href="ubfm.xml#WnOrWZR">&lt;Wn&gt;</a><text>, #</text><a hover="For the &quot;32-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 31." href="ubfm.xml#lsb__2">&lt;lsb&gt;</a><text>, #(</text><a hover="For the &quot;32-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 31." href="ubfm.xml#lsb__2">&lt;lsb&gt;</a><text>+</text><a hover="For the &quot;32-bit&quot; variant: is the width of the bitfield, in the range 1 to 32-&lt;lsb&gt;." href="ubfm.xml#width">&lt;width&gt;</a><text>-1)</text></asmtemplate>
          <aliascond>BFXPreferred(sf, opc[1], imms, immr)</aliascond>
        </equivalent_to>
      </encoding>
      <encoding name="UBFX_UBFM_64M_bitfield" oneofinclass="2" oneof="2" label="64-bit" bitdiffs="sf == 1 &amp;&amp; N == 1">
        <docvars>
          <docvar key="bitfield-fill" value="zero-fill"/>
          <docvar key="datatype" value="64"/>
          <docvar key="instr-class" value="general"/>
          <docvar key="isa" value="A64"/>
          <docvar key="mnemonic" value="UBFM"/>
          <docvar key="alias_mnemonic" value="UBFX"/>
        </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>UBFX  </text><a hover="Is the 64-bit name of the general-purpose destination register, encoded in the &quot;Rd&quot; field." link="XdOrXZR__6">&lt;Xd&gt;</a><text>, </text><a hover="Is the 64-bit name of the general-purpose source register, encoded in the &quot;Rn&quot; field." link="XnOrXZR__11">&lt;Xn&gt;</a><text>, #</text><a hover="For the &quot;64-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 63." link="lsb__4">&lt;lsb&gt;</a><text>, #</text><a hover="For the &quot;64-bit&quot; variant: is the width of the bitfield, in the range 1 to 64-&lt;lsb&gt;." link="width__2">&lt;width&gt;</a></asmtemplate>
        <equivalent_to>
          <asmtemplate><a href="ubfm.xml#UBFM_64M_bitfield">UBFM</a><text>  </text><a hover="Is the 64-bit name of the general-purpose destination register, encoded in the &quot;Rd&quot; field." href="ubfm.xml#XdOrXZR__6">&lt;Xd&gt;</a><text>, </text><a hover="Is the 64-bit name of the general-purpose source register, encoded in the &quot;Rn&quot; field." href="ubfm.xml#XnOrXZR__11">&lt;Xn&gt;</a><text>, #</text><a hover="For the &quot;64-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 63." href="ubfm.xml#lsb__4">&lt;lsb&gt;</a><text>, #(</text><a hover="For the &quot;64-bit&quot; variant: is the bit number of the lsb of the source bitfield, in the range 0 to 63." href="ubfm.xml#lsb__4">&lt;lsb&gt;</a><text>+</text><a hover="For the &quot;64-bit&quot; variant: is the width of the bitfield, in the range 1 to 64-&lt;lsb&gt;." href="ubfm.xml#width__2">&lt;width&gt;</a><text>-1)</text></asmtemplate>
          <aliascond>BFXPreferred(sf, opc[1], imms, immr)</aliascond>
        </equivalent_to>
      </encoding>
    </iclass>
  </classes>
  <explanations scope="all">
    <explanation enclist="UBFX_UBFM_32M_bitfield" symboldefcount="1">
      <symbol link="WdOrWZR">&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="UBFX_UBFM_32M_bitfield" symboldefcount="1">
      <symbol link="WnOrWZR">&lt;Wn&gt;</symbol>
      <account encodedin="Rn">
        <intro>
          <para>Is the 32-bit name of the general-purpose source register, encoded in the "Rn" field.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="UBFX_UBFM_32M_bitfield" symboldefcount="1">
      <symbol link="lsb__2">&lt;lsb&gt;</symbol>
      <account encodedin="immr">
        <intro>
          <para>For the "32-bit" variant: is the bit number of the lsb of the source bitfield, in the range 0 to 31.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="UBFX_UBFM_64M_bitfield" symboldefcount="2">
      <symbol link="lsb__4">&lt;lsb&gt;</symbol>
      <account encodedin="immr">
        <intro>
          <para>For the "64-bit" variant: is the bit number of the lsb of the source bitfield, in the range 0 to 63.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="UBFX_UBFM_32M_bitfield" symboldefcount="1">
      <symbol link="width">&lt;width&gt;</symbol>
      <account encodedin="(imms :: immr)">
        <intro>
          <para>For the "32-bit" variant: is the width of the bitfield, in the range 1 to 32-&lt;lsb&gt;.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="UBFX_UBFM_64M_bitfield" symboldefcount="2">
      <symbol link="width__2">&lt;width&gt;</symbol>
      <account encodedin="(imms :: immr)">
        <intro>
          <para>For the "64-bit" variant: is the width of the bitfield, in the range 1 to 64-&lt;lsb&gt;.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="UBFX_UBFM_64M_bitfield" symboldefcount="1">
      <symbol link="XdOrXZR__6">&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="UBFX_UBFM_64M_bitfield" symboldefcount="1">
      <symbol link="XnOrXZR__11">&lt;Xn&gt;</symbol>
      <account encodedin="Rn">
        <intro>
          <para>Is the 64-bit name of the general-purpose source register, encoded in the "Rn" field.</para>
        </intro>
      </account>
    </explanation>
  </explanations>
  <timestamp>2026-03-12 12:23:09</timestamp>
  <commit_id>2025-09_rel_asl1</commit_id>
</instructionsection>
