blob: 5775712f81d9bde762a80080803a333b38bc8a7a [file]
<!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<!--FAVICON.ico-->
<meta name="msapplication-TileColor" content="#2b5797">
<meta name="msapplication-TileImage" content="../img/mstile-144x144.png">
<link rel="icon" href="../img/favicon.ico">
<title>Instruction.Instructions - ARM Machine Readable Schema - 2.6.3</title>
<!--CSS-->
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/schema.css">
<link rel="stylesheet" type="text/css" href="../css/hljs-github.css">
</head>
<body>
<div class="container">
<div class="row heading">
<div class="col-md-6 pull-left"><a href="../index.html"><img src="../img/arm.svg" class="logo" /></a></div>
<div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.6.3</small></h1></div>
<!--Show the home button-->
<a href="../index.html"><div class="back-to-home">&nlarr; Home</div></a>
</div>
</div>
<div class="container">
<div class="row">
<h2>
<span class="title-namespace">Instruction.</span><span class=" title-type">Instructions</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>This is a wrapper object for all InstructionSets.</p>
<p>The example below is for an instance of <a class="schema_link" href="../Instruction/Instructions_schema.html" title="Instruction.Instructions">Instructions</a> that contains one
instruction set, named 'EXAMPLE', which has a single instruction, named 'NOP'.</p></div>
</div>
<div class="row">
<div>
<!-- A simple object -->
<h3 class="type">object</h3>
<table class="table table-hover properties">
<thead>
<tr>
<th class="col-md-4">Properties</th>
<th class="col-md-4">Type</th>
<th class="col-md-4">Description</th>
</tr>
</thead>
<tbody>
<!-- properties -->
<tr id="/properties/_meta" class="property">
<th class="col-md-4">
<a href="#/properties/_meta">_meta</a>
</th>
<td class="col-md-4">
<a href="../Meta_schema.html" class="schema_link">Meta</a>
</td>
<td class="col-md-4">
<div><p>Metadata</p></div>
<div>
See
<a href="../Meta_schema.html" class="schema_link">Meta</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/_type" class="property">
<th class="col-md-4">
<a href="#/properties/_type">_type</a>
</th>
<td class="col-md-4">
</td>
<td class="col-md-4">
<dl>
<dt>Enum</dt>
<dd>
<code>Instruction.Instructions</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/assembly_rules" class="property">
<th class="col-md-4">
<a href="#/properties/assembly_rules">assembly_rules</a>
</th>
<td class="col-md-4">
<div>
<span class="type">object</span> {
<code title="Regex">/^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$/</code> :
</div>
<div class="items-oneOf">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
<a href="Rules/Choice_schema.html" class="schema_link">Rules.Choice</a>
</div>
<div class="items-oneOf">
<a href="Rules/Rule_schema.html" class="schema_link">Rules.Rule</a>
</div>
<div class="items-oneOf">
<a href="Rules/Token_schema.html" class="schema_link">Rules.Token</a>
</div>
<div>]</div>
</div>
<div>}</div>
</td>
<td class="col-md-4">
<div><p>The dictionary of assembly rules that is used in this instruction set.
An entry in this dictionary is a key:value pair, where the key is the unique
string identifier for the assembly rule and the value is an instance of
<code>Rules.Choice</code>, <code>Rules.Rule</code>, or <code>Rules.Token</code>.</p></div>
</td>
</tr>
<tr id="/properties/instructions" class="property">
<th class="col-md-4">
<a href="#/properties/instructions">instructions</a>
</th>
<td class="col-md-4">
<div><span class="type">array</span> [</div>
<a href="InstructionSet_schema.html" class="schema_link">InstructionSet</a>
<div>]</div>
</td>
<td class="col-md-4">
<div><p>A list of instances of <a class="schema_link" href="../Instruction/InstructionSet_schema.html" title="Instruction.InstructionSet">InstructionSet</a>.</p></div>
</td>
</tr>
<tr id="/properties/operations" class="property">
<th class="col-md-4">
<a href="#/properties/operations">operations</a>
</th>
<td class="col-md-4">
<div>
<span class="type">object</span> {
<code title="Regex">/^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$/</code> :
</div>
<div class="items-oneOf">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
<a href="Operation_schema.html" class="schema_link">Operation</a>
</div>
<div class="items-oneOf">
<a href="OperationAlias_schema.html" class="schema_link">OperationAlias</a>
</div>
<div>]</div>
</div>
<div>}</div>
</td>
<td class="col-md-4">
<div><p>The dictionary of operations for the instructions.
An entry in this dictionary is a key:value pair, where the key is the unique
string identifier for the operation and the value is an instance of
<code>Operation</code> or <code>OperationAlias</code>.</p></div>
</td>
</tr>
<!-- patternProperties -->
<!-- object property attributes -->
<tr>
<td colspan="3">
<dl>
<dt>Additional Properties</dt>
<dd>Not Allowed</dd>
</dl>
</td>
</tr>
<tr>
<td colspan="3">
<dl>
<dt>&loz; Required</dt>
<dd>Properties marked with &loz; are required properties.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<!-- array, and it has described items -->
</div>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Instruction.Instructions&#34;,
&#34;instructions&#34;: [
{
&#34;_type&#34;: &#34;Instruction.InstructionSet&#34;,
&#34;name&#34;: &#34;EXAMPLE&#34;,
&#34;read_width&#34;: 32,
&#34;encoding&#34;: {
&#34;_type&#34;: &#34;Instruction.Encodeset.Encodeset&#34;,
&#34;width&#34;: 32,
&#34;values&#34;: []
},
&#34;children&#34;: [
{
&#34;_type&#34;: &#34;Instruction.Instruction&#34;,
&#34;name&#34;: &#34;NOP&#34;,
&#34;assembly&#34;: {
&#34;_type&#34;: &#34;Instruction.Assembly&#34;,
&#34;symbols&#34;: [
{
&#34;_type&#34;: &#34;Instruction.Symbols.Literal&#34;,
&#34;value&#34;: &#34;NOP&#34;
}
]
},
&#34;encoding&#34;: {
&#34;_type&#34;: &#34;Instruction.Encodeset.Encodeset&#34;,
&#34;width&#34;: 32,
&#34;values&#34;: [
{
&#34;_type&#34;: &#34;Instruction.Encodeset.Bits&#34;,
&#34;range&#34;: {
&#34;_type&#34;: &#34;Range&#34;,
&#34;start&#34;: 0,
&#34;width&#34;: 32
},
&#34;value&#34;: {
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;value&#34;: &#34;&#39;00000000000000000000000000000000&#39;&#34;,
&#34;meaning&#34;: null
},
&#34;should_be_mask&#34;: {
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;value&#34;: &#34;&#39;00000000000000000000000000000000&#39;&#34;
}
}
]
},
&#34;operation_id&#34;: &#34;ExampleOp&#34;,
&#34;assemble&#34;: null,
&#34;disassemble&#34;: null,
&#34;assertions&#34;: null
}
],
&#34;operation_id&#34;: null,
&#34;condition&#34;: {
&#34;_type&#34;: &#34;AST.Bool&#34;,
&#34;value&#34;: true
}
}
],
&#34;assembly_rules&#34;: {
&#34;EMPTY&#34;: {
&#34;_type&#34;: &#34;Instruction.Rules.Token&#34;,
&#34;pattern&#34;: &#34;&#34;,
&#34;default&#34;: &#34;&#34;
},
&#34;SPACE&#34;: {
&#34;_type&#34;: &#34;Instruction.Rules.Token&#34;,
&#34;pattern&#34;: &#34;\\s+&#34;,
&#34;default&#34;: &#34; &#34;
}
},
&#34;operations&#34;: {
&#34;ExampleOp&#34;: {
&#34;_type&#34;: &#34;Instruction.Operation&#34;,
&#34;title&#34;: &#34;ExampleOp&#34;,
&#34;operation&#34;: [
[
&#34;bits(32) result = 0;&#34;,
&#34;X[0, 32] = result;&#34;
]
],
&#34;brief&#34;: &#34;An example operation.&#34;,
&#34;description&#34;: &#34;A more detailed description of the example operation.&#34;
}
}
}</code></pre>
</div>
</div>
<div class="row schema">
<h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3>
<pre class="schema-json"><code class="language-json">{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Instruction.Instructions",
"info": [
"This is a wrapper object for all InstructionSets.",
[
"The example below is for an instance of $(~Instruction.Instructions) that contains one",
"instruction set, named 'EXAMPLE', which has a single instruction, named 'NOP'."
]
],
"examples": [
{
"_type": "Instruction.Instructions",
"instructions": [
{
"_type": "Instruction.InstructionSet",
"name": "EXAMPLE",
"read_width": 32,
"encoding": {
"_type": "Instruction.Encodeset.Encodeset",
"width": 32,
"values": []
},
"children": [
{
"_type": "Instruction.Instruction",
"name": "NOP",
"assembly": {
"_type": "Instruction.Assembly",
"symbols": [
{
"_type": "Instruction.Symbols.Literal",
"value": "NOP"
}
]
},
"encoding": {
"_type": "Instruction.Encodeset.Encodeset",
"width": 32,
"values": [
{
"_type": "Instruction.Encodeset.Bits",
"range": {
"_type": "Range",
"start": 0,
"width": 32
},
"value": {
"_type": "Values.Value",
"value": "'00000000000000000000000000000000'",
"meaning": null
},
"should_be_mask": {
"_type": "Values.Value",
"value": "'00000000000000000000000000000000'"
}
}
]
},
"operation_id": "ExampleOp",
"assemble": null,
"disassemble": null,
"assertions": null
}
],
"operation_id": null,
"condition": {
"_type": "AST.Bool",
"value": true
}
}
],
"assembly_rules": {
"EMPTY": {
"_type": "Instruction.Rules.Token",
"pattern": "",
"default": ""
},
"SPACE": {
"_type": "Instruction.Rules.Token",
"pattern": "\\s+",
"default": " "
}
},
"operations": {
"ExampleOp": {
"_type": "Instruction.Operation",
"title": "ExampleOp",
"operation": [
[
"bits(32) result = 0;",
"X[0, 32] = result;"
]
],
"brief": "An example operation.",
"description": "A more detailed description of the example operation."
}
}
}
],
"type": "object",
"properties": {
"_meta": {
"$ref": "../Meta.json",
"info": [
"Metadata"
]
},
"_type": {
"enum": [
"Instruction.Instructions"
]
},
"assembly_rules": {
"info": [
[
"The dictionary of assembly rules that is used in this instruction set.",
"An entry in this dictionary is a key:value pair, where the key is the unique ",
"string identifier for the assembly rule and the value is an instance of",
"`Rules.Choice`, `Rules.Rule`, or `Rules.Token`."
]
],
"type": "object",
"patternProperties": {
"^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$": {
"info": [
"Either a lexical rule or a grammatical assembly rule"
],
"type": "object",
"oneOf": [
{
"$ref": "Rules/Choice.json"
},
{
"$ref": "Rules/Rule.json"
},
{
"$ref": "Rules/Token.json"
}
]
}
},
"additionalProperties": false
},
"instructions": {
"type": "array",
"info": [
"A list of instances of $(~Instruction.InstructionSet)."
],
"items": {
"$ref": "InstructionSet.json"
}
},
"operations": {
"info": [
[
"The dictionary of operations for the instructions.",
"An entry in this dictionary is a key:value pair, where the key is the unique ",
"string identifier for the operation and the value is an instance of",
"`Operation` or `OperationAlias`."
]
],
"type": "object",
"patternProperties": {
"^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$": {
"oneOf": [
{
"$ref": "Operation.json"
},
{
"$ref": "OperationAlias.json"
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}</code></pre>
</div>
</div>
<div class="container">
<div class="footer text-right">
Copyright &copy; 2025 ARM Limited or its affiliates. All rights reserved.
</div>
</div>
<script src="../js/highlight/highlight.js"></script>
<script src="../js/highlight/languages/json.min.js"></script>
<script src="../js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
<script src="../js/highlight/languages/yaml.min.js"></script>
<script src="../js/highlight/languages/isa.js"></script>
<script type="text/javascript">
window.onload = function() {
hljs.configure({
cssSelector: ".schema-json code, .includes code, pre code",
noHighlightRe: /^(no-?highlight|nohl)$/i,
});
hljs.highlightAll()
};
</script>
</body>
</html>