<?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="MOVK" title="MOVK -- A64" type="instruction">
  <docvars>
    <docvar key="immediate-type" value="imm18-packed" />
    <docvar key="instr-class" value="general" />
    <docvar key="isa" value="A64" />
    <docvar key="mnemonic" value="MOVK" />
  </docvars>
  <heading>MOVK</heading>
  <desc>
    <brief>
      <para>Move wide with keep</para>
    </brief>
    <authored>
      <para>Move wide with keep moves an optionally-shifted 16-bit immediate value into a register, keeping other bits unchanged.</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>
  <alias_list howmany="0"></alias_list>
  <classes>
    <iclass name="Immediate packed into 16-bit value and 2-bit shift" oneof="1" id="iclass_imm18_packed" no_encodings="2" isa="A64">
      <docvars>
        <docvar key="immediate-type" value="imm18-packed" />
        <docvar key="instr-class" value="general" />
        <docvar key="isa" value="A64" />
        <docvar key="mnemonic" value="MOVK" />
      </docvars>
      <iclassintro count="2"></iclassintro>
      <regdiagram form="32" psname="aarch64/instrs/integer/ins-ext/insert/movewide" tworows="1">
        <box hibit="31" name="sf" usename="1">
          <c></c>
        </box>
        <box hibit="30" width="2" name="opc" usename="1" settings="2" psbits="xx">
          <c>1</c>
          <c>1</c>
        </box>
        <box hibit="28" width="6" settings="6">
          <c>1</c>
          <c>0</c>
          <c>0</c>
          <c>1</c>
          <c>0</c>
          <c>1</c>
        </box>
        <box hibit="22" width="2" name="hw" usename="1">
          <c colspan="2"></c>
        </box>
        <box hibit="20" width="16" name="imm16" usename="1">
          <c colspan="16"></c>
        </box>
        <box hibit="4" width="5" name="Rd" usename="1">
          <c colspan="5"></c>
        </box>
      </regdiagram>
      <encoding name="MOVK_32_movewide" oneofinclass="2" oneof="2" label="32-bit" bitdiffs="sf == 0 &amp;&amp; hw == 0x">
        <docvars>
          <docvar key="datatype" value="32" />
          <docvar key="immediate-type" value="imm18-packed" />
          <docvar key="instr-class" value="general" />
          <docvar key="isa" value="A64" />
          <docvar key="mnemonic" value="MOVK" />
        </docvars>
        <box hibit="31" width="1" name="sf">
          <c>0</c>
        </box>
        <box hibit="22" width="2" name="hw">
          <c>0</c>
          <c></c>
        </box>
        <asmtemplate><text>MOVK  </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_imm" hover="16-bit unsigned immediate [0-65535] (field &quot;imm16&quot;)">&lt;imm&gt;</a><text>{</text><text>, LSL #</text><a link="sa_shift" hover="Amount by which to shift the immediate left (field &quot;hw&quot;)">&lt;shift&gt;</a><text>}</text></asmtemplate>
      </encoding>
      <encoding name="MOVK_64_movewide" oneofinclass="2" oneof="2" label="64-bit" bitdiffs="sf == 1">
        <docvars>
          <docvar key="datatype" value="64" />
          <docvar key="immediate-type" value="imm18-packed" />
          <docvar key="instr-class" value="general" />
          <docvar key="isa" value="A64" />
          <docvar key="mnemonic" value="MOVK" />
        </docvars>
        <box hibit="31" width="1" name="sf">
          <c>1</c>
        </box>
        <asmtemplate><text>MOVK  </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_imm" hover="16-bit unsigned immediate [0-65535] (field &quot;imm16&quot;)">&lt;imm&gt;</a><text>{</text><text>, LSL #</text><a link="sa_shift_1" hover="Amount by which to shift the immediate left (field &quot;hw&quot;)">&lt;shift&gt;</a><text>}</text></asmtemplate>
      </encoding>
      <ps_section howmany="1">
        <ps name="aarch64/instrs/integer/ins-ext/insert/movewide" mylink="aarch64.instrs.integer.ins-ext.insert.movewide" 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 datasize = if sf == '1' then 64 else 32;
bits(16) imm = imm16;
integer pos;
<a link="MoveWideOp" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp</a> opcode;

case opc of
    when '00' opcode = <a link="MoveWideOp_N" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp_N</a>;
    when '10' opcode = <a link="MoveWideOp_Z" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp_Z</a>;
    when '11' opcode = <a link="MoveWideOp_K" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp_K</a>;
    otherwise UNDEFINED;

if sf == '0' &amp;&amp; hw&lt;1&gt; == '1' then UNDEFINED;
pos = <a link="impl-shared.UInt.1" file="shared_pseudocode.xml" hover="function: integer UInt(bits(N) x)">UInt</a>(hw:'0000');</pstext>
        </ps>
      </ps_section>
    </iclass>
  </classes>
  <explanations scope="all">
    <explanation enclist="MOVK_32_movewide" 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="MOVK_64_movewide" 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="MOVK_32_movewide, MOVK_64_movewide" symboldefcount="1">
      <symbol link="sa_imm">&lt;imm&gt;</symbol>
      <account encodedin="imm16">
        <intro>
          <para>Is the 16-bit unsigned immediate, in the range 0 to 65535, encoded in the "imm16" field.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="MOVK_32_movewide" symboldefcount="1">
      <symbol link="sa_shift">&lt;shift&gt;</symbol>
      <account encodedin="hw">
        <docvars>
          <docvar key="datatype" value="32" />
        </docvars>
        <intro>
          <para>For the 32-bit variant: is the amount by which to shift the immediate left, either 0 (the default) or 16, encoded in the "hw" field as &lt;shift&gt;/16.</para>
        </intro>
      </account>
    </explanation>
    <explanation enclist="MOVK_64_movewide" symboldefcount="2">
      <symbol link="sa_shift_1">&lt;shift&gt;</symbol>
      <account encodedin="hw">
        <docvars>
          <docvar key="datatype" value="64" />
        </docvars>
        <intro>
          <para>For the 64-bit variant: is the amount by which to shift the immediate left, either 0 (the default), 16, 32 or 48, encoded in the "hw" field as &lt;shift&gt;/16.</para>
        </intro>
      </account>
    </explanation>
  </explanations>
  <ps_section howmany="1">
    <ps name="aarch64/instrs/integer/ins-ext/insert/movewide" mylink="execute" enclabels="" sections="1" secttype="Operation">
      <pstext mayhavelinks="1" section="Execute" rep_section="execute">bits(datasize) result;

if opcode == <a link="MoveWideOp_K" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp_K</a> then
    result = <a link="impl-aarch64.X.read.2" file="shared_pseudocode.xml" hover="accessor: bits(width) X[integer n, integer width]">X</a>[d, datasize];
else
    result = <a link="impl-shared.Zeros.1" file="shared_pseudocode.xml" hover="function: bits(N) Zeros(integer N)">Zeros</a>(datasize);

result&lt;pos+15:pos&gt; = imm;
if opcode == <a link="MoveWideOp_N" file="shared_pseudocode.xml" hover="enumeration MoveWideOp  {MoveWideOp_N, MoveWideOp_Z, MoveWideOp_K}">MoveWideOp_N</a> then
    result = NOT(result);
<a link="impl-aarch64.X.write.2" file="shared_pseudocode.xml" hover="accessor: X[integer n, integer width] = bits(width) value">X</a>[d, datasize] = result;</pstext>
    </ps>
  </ps_section>
</instructionsection>
