slonik/specs/setpan.xml

216 lines
8 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="SETPAN" title="SETPAN -- AArch32" type="instruction">
<docvars>
<docvar key="instr-class" value="general" />
<docvar key="mnemonic" value="SETPAN" />
</docvars>
<heading>SETPAN</heading>
<desc>
<brief>
<para>Set Privileged Access Never</para>
</brief>
<authored>
<para>Set Privileged Access Never writes a new value to <xref linkend="BEIDIGBH">PSTATE</xref>.PAN.</para>
<para>This instruction is available only in privileged mode and it is a NOP when executed in User mode.</para>
</authored>
</desc>
<alias_list howmany="0"></alias_list>
<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="1" isa="A32">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="SETPAN" />
</docvars>
<iclassintro count="1"></iclassintro>
<arch_variants>
<arch_variant name="ARMv8.1" feature="FEAT_PAN" />
</arch_variants>
<regdiagram form="32" psname="aarch32/instrs/SETPAN/A1_A.txt">
<box hibit="31" width="12" settings="12">
<c>1</c>
<c>1</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>1</c>
</box>
<box hibit="19" settings="1">
<c>(0)</c>
</box>
<box hibit="18" settings="1">
<c>(0)</c>
</box>
<box hibit="17" settings="1">
<c>(0)</c>
</box>
<box hibit="16" settings="1">
<c>(0)</c>
</box>
<box hibit="15" settings="1">
<c>(0)</c>
</box>
<box hibit="14" settings="1">
<c>(0)</c>
</box>
<box hibit="13" settings="1">
<c>(0)</c>
</box>
<box hibit="12" settings="1">
<c>(0)</c>
</box>
<box hibit="11" settings="1">
<c>(0)</c>
</box>
<box hibit="10" settings="1">
<c>(0)</c>
</box>
<box hibit="9" name="imm1" usename="1">
<c></c>
</box>
<box hibit="8" settings="1">
<c>(0)</c>
</box>
<box hibit="7" width="4" settings="4">
<c>0</c>
<c>0</c>
<c>0</c>
<c>0</c>
</box>
<box hibit="3" settings="1">
<c>(0)</c>
</box>
<box hibit="2" settings="1">
<c>(0)</c>
</box>
<box hibit="1" settings="1">
<c>(0)</c>
</box>
<box hibit="0" settings="1">
<c>(0)</c>
</box>
</regdiagram>
<encoding name="SETPAN_A1" oneofinclass="1" oneof="2" label="A1">
<docvars>
<docvar key="armarmheading" value="A1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="A32" />
<docvar key="mnemonic" value="SETPAN" />
</docvars>
<asmtemplate comment="Cannot be conditional"><text>SETPAN</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> #</text><a link="sa_imm" hover="Unsigned immediate 0 or 1 (field &quot;imm1&quot;)">&lt;imm&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SETPAN/A1_A.txt" mylink="aarch32.instrs.SETPAN.A1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if !<a link="impl-shared.HavePANExt.0" file="shared_pseudocode.xml" hover="function: boolean HavePANExt()">HavePANExt</a>() then UNDEFINED;
value = imm1;</pstext>
</ps>
</ps_section>
</iclass>
<iclass name="T1" oneof="2" id="iclass_t1" no_encodings="1" isa="T32">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SETPAN" />
</docvars>
<iclassintro count="1"></iclassintro>
<arch_variants>
<arch_variant name="ARMv8.1" feature="FEAT_PAN" />
</arch_variants>
<regdiagram form="16" psname="aarch32/instrs/SETPAN/T1_A.txt">
<box hibit="31" width="11" settings="11">
<c>1</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>1</c>
<c>1</c>
<c>0</c>
<c>0</c>
<c>0</c>
<c>0</c>
</box>
<box hibit="20" settings="1">
<c>(1)</c>
</box>
<box hibit="19" name="imm1" usename="1">
<c></c>
</box>
<box hibit="18" settings="1">
<c>(0)</c>
</box>
<box hibit="17" settings="1">
<c>(0)</c>
</box>
<box hibit="16" settings="1">
<c>(0)</c>
</box>
</regdiagram>
<encoding name="SETPAN_T1" oneofinclass="1" oneof="2" label="T1">
<docvars>
<docvar key="armarmheading" value="T1" />
<docvar key="instr-class" value="general" />
<docvar key="isa" value="T32" />
<docvar key="mnemonic" value="SETPAN" />
</docvars>
<asmtemplate comment="Not permitted in IT block"><text>SETPAN</text><text>{</text><a link="sa_q" hover="See {xref{ARMARM_Babbefhf}{Standard assembler syntax fields}}">&lt;q&gt;</a><text>}</text><text> #</text><a link="sa_imm" hover="Unsigned immediate 0 or 1 (field &quot;imm1&quot;)">&lt;imm&gt;</a></asmtemplate>
</encoding>
<ps_section howmany="1">
<ps name="aarch32/instrs/SETPAN/T1_A.txt" mylink="aarch32.instrs.SETPAN.T1_A.txt" enclabels="" sections="1" secttype="noheading">
<pstext mayhavelinks="1" section="Decode" rep_section="decode">if <a link="impl-aarch32.InITBlock.0" file="shared_pseudocode.xml" hover="function: boolean InITBlock()">InITBlock</a>() then UNPREDICTABLE;
if !<a link="impl-shared.HavePANExt.0" file="shared_pseudocode.xml" hover="function: boolean HavePANExt()">HavePANExt</a>() then UNDEFINED;
value = imm1;</pstext>
</ps>
</ps_section>
</iclass>
</classes>
<explanations scope="all">
<explanation enclist="SETPAN_A1, SETPAN_T1" symboldefcount="1">
<symbol link="sa_q">&lt;q&gt;</symbol>
<account encodedin="">
<intro>
<para>See <xref linkend="Babbefhf">Standard assembler syntax fields</xref>.</para>
</intro>
</account>
</explanation>
<explanation enclist="SETPAN_A1, SETPAN_T1" symboldefcount="1">
<symbol link="sa_imm">&lt;imm&gt;</symbol>
<account encodedin="imm1">
<intro>
<para>Is the unsigned immediate 0 or 1, encoded in the "imm1" field.</para>
</intro>
</account>
</explanation>
</explanations>
<ps_section howmany="1">
<ps name="aarch32/instrs/SETPAN/Op_A.txt" mylink="execute" enclabels="" sections="1" secttype="Operation">
<pstext mayhavelinks="1" section="Execute" rep_section="execute">EncodingSpecificOperations();
if PSTATE.EL != <a link="EL0" file="shared_pseudocode.xml" hover="constant bits(2) EL0 = '00'">EL0</a> then
PSTATE.PAN = value;</pstext>
</ps>
</ps_section>
</instructionsection>