| <!-- 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>MapArray - 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">Mapping.</span><span class=" title-type">MapArray</span> | |
| <!-- if oneOf is set, then type is ignored --> | |
| <span class="type">object</span> | |
| </h2> | |
| <div class="static-markdown"><p>Provides mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers like Map, except it is expandable based on an index.</p> | |
| <p>When expanded, the values defined in the <code>indexes</code> property are used to generate multiple Map objects, one for each index.</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>Mapping.MapArray</code> | |
| </dd> | |
| </dl> | |
| </td> | |
| </tr> | |
| <tr id="/properties/condition" class="property"> | |
| <th class="col-md-4"> | |
| <a href="#/properties/condition">condition</a> | |
| </th> | |
| <td class="col-md-4"> | |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a> | |
| </td> | |
| <td class="col-md-4"> | |
| <div><p>This condition must be true for the mapping to exist.</p></div> | |
| <div> | |
| See | |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">definitions.condition</a> in | |
| <a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a> | |
| for more information. | |
| </div> | |
| </td> | |
| </tr> | |
| <tr id="/properties/index_variable" class="property"> | |
| <th class="col-md-4"> | |
| <a href="#/properties/index_variable">index_variable<sup>◊</sup></a> | |
| </th> | |
| <td class="col-md-4"> | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/index_variable" class="schema_link">Traits.HasIndexes</a> | |
| </td> | |
| <td class="col-md-4"> | |
| <div> | |
| See | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/index_variable" class="schema_link">definitions.index_variable</a> in | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/index_variable" class="schema_link">Traits.HasIndexes</a> | |
| for more information. | |
| </div> | |
| </td> | |
| </tr> | |
| <tr id="/properties/indexes" class="property"> | |
| <th class="col-md-4"> | |
| <a href="#/properties/indexes">indexes<sup>◊</sup></a> | |
| </th> | |
| <td class="col-md-4"> | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/indexes" class="schema_link">Traits.HasIndexes</a> | |
| </td> | |
| <td class="col-md-4"> | |
| <div> | |
| See | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/indexes" class="schema_link">definitions.indexes</a> in | |
| <a href="../Traits/HasIndexes_schema.html#/definitions/indexes" class="schema_link">Traits.HasIndexes</a> | |
| for more information. | |
| </div> | |
| </td> | |
| </tr> | |
| <tr id="/properties/maps" class="property"> | |
| <th class="col-md-4"> | |
| <a href="#/properties/maps">maps<sup>◊</sup></a> | |
| </th> | |
| <td class="col-md-4"> | |
| <a href="Map_schema.html#/definitions/maps" class="schema_link">Map</a> | |
| </td> | |
| <td class="col-md-4"> | |
| <div> | |
| See | |
| <a href="Map_schema.html#/definitions/maps" class="schema_link">definitions.maps</a> in | |
| <a href="Map_schema.html#/definitions/maps" class="schema_link">Map</a> | |
| for more information. | |
| </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": "Mapping.MapArray", | |
| "condition": { | |
| "_type": "AST.Function", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Identifier", | |
| "value": "EL1" | |
| } | |
| ], | |
| "name": "IsFeatureImplemented" | |
| }, | |
| "indexes": [ | |
| { | |
| "_type": "Range", | |
| "start": 4, | |
| "width": 1 | |
| } | |
| ], | |
| "index_variable": "x", | |
| "maps": [ | |
| { | |
| "_type": "AST.SquareOp", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Slice", | |
| "left": { | |
| "_type": "AST.Integer", | |
| "value": 31 | |
| }, | |
| "right": { | |
| "_type": "AST.Integer", | |
| "value": 0 | |
| } | |
| } | |
| ], | |
| "var": { | |
| "_type": "Types.RegisterType", | |
| "value": { | |
| "instance": null, | |
| "name": "REG<x>", | |
| "slices": null, | |
| "state": "AArch64" | |
| } | |
| } | |
| }, | |
| { | |
| "_type": "AST.SquareOp", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Slice", | |
| "left": { | |
| "_type": "AST.Integer", | |
| "value": 31 | |
| }, | |
| "right": { | |
| "_type": "AST.Integer", | |
| "value": 0 | |
| } | |
| } | |
| ], | |
| "var": { | |
| "_type": "AST.Identifier", | |
| "value": "REG<x>" | |
| } | |
| } | |
| ] | |
| }</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">{ | |
| "title": "MapArray", | |
| "additionalProperties": false, | |
| "properties": { | |
| "_meta": { | |
| "$ref": "../Meta.json", | |
| "info": [ | |
| "Metadata" | |
| ] | |
| }, | |
| "_type": { | |
| "enum": [ | |
| "Mapping.MapArray" | |
| ] | |
| }, | |
| "maps": { | |
| "$ref": "Map.json#/definitions/maps" | |
| }, | |
| "condition": { | |
| "$ref": "../Traits/HasCondition.json#/definitions/condition", | |
| "info": [ | |
| "This condition must be true for the mapping to exist." | |
| ] | |
| }, | |
| "indexes": { | |
| "$ref": "../Traits/HasIndexes.json#/definitions/indexes" | |
| }, | |
| "index_variable": { | |
| "$ref": "../Traits/HasIndexes.json#/definitions/index_variable" | |
| } | |
| }, | |
| "examples": [ | |
| { | |
| "_type": "Mapping.MapArray", | |
| "condition": { | |
| "_type": "AST.Function", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Identifier", | |
| "value": "EL1" | |
| } | |
| ], | |
| "name": "IsFeatureImplemented" | |
| }, | |
| "indexes": [ | |
| { | |
| "_type": "Range", | |
| "start": 4, | |
| "width": 1 | |
| } | |
| ], | |
| "index_variable": "x", | |
| "maps": [ | |
| { | |
| "_type": "AST.SquareOp", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Slice", | |
| "left": { | |
| "_type": "AST.Integer", | |
| "value": 31 | |
| }, | |
| "right": { | |
| "_type": "AST.Integer", | |
| "value": 0 | |
| } | |
| } | |
| ], | |
| "var": { | |
| "_type": "Types.RegisterType", | |
| "value": { | |
| "instance": null, | |
| "name": "REG<x>", | |
| "slices": null, | |
| "state": "AArch64" | |
| } | |
| } | |
| }, | |
| { | |
| "_type": "AST.SquareOp", | |
| "arguments": [ | |
| { | |
| "_type": "AST.Slice", | |
| "left": { | |
| "_type": "AST.Integer", | |
| "value": 31 | |
| }, | |
| "right": { | |
| "_type": "AST.Integer", | |
| "value": 0 | |
| } | |
| } | |
| ], | |
| "var": { | |
| "_type": "AST.Identifier", | |
| "value": "REG<x>" | |
| } | |
| } | |
| ] | |
| } | |
| ], | |
| "required": [ | |
| "maps", | |
| "indexes", | |
| "index_variable" | |
| ], | |
| "type": "object", | |
| "$schema": "http://json-schema.org/draft-04/schema#", | |
| "info": [ | |
| "Provides mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers like Map, except it is expandable based on an index.", | |
| "When expanded, the values defined in the `indexes` property are used to generate multiple Map objects, one for each index." | |
| ] | |
| }</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> |