| <!-- Copyright (c) 2010-2026 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.9.6</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.9.6</small></h1></div> | |
| <!--Show the home button--> | |
| <a href="../index.html"><div class="back-to-home">↚ 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>◊ Required</dt> | |
| <dd>Properties marked with ◊ 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">{ | |
| "_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." | |
| } | |
| } | |
| }</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 © 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> |