docs/Mapping/Map_schema.html - pub/scm/linux/kernel/git/maz/AARCHMRS - Git at Google

 <!-- 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>Map - ARM Machine Readable Schema - 2.5.5</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.5.5</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">Mapping.</span><span class=" title-type">Map</span>

             <!-- if oneOf is set, then type is ignored -->
                 <span class="type">object</span>
         </h2>


     <div class="static-markdown"><p><code>Map</code> provides a bi-directional mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers.</p>
 <p>For example, if the maps property lists <code>REGBLOCK1.REG1</code>, <code>REGBLOCK1.REG2</code> and
 <code>AArch32-ACTRL</code>, then there exists a bidirectional mapping between all three items.</p></div>
 </div>

 <!-- definitions -->
 <div class="row">
     <h3><span class="type Xof">definition</span></h3>
     <table class="table table-hover definitions">
         <thead>
             <tr>
                 <th class="col-md-4">Definitions</th>
                 <th class="col-md-4">Type</th>
                 <th class="col-md-4">Description</th>
             </tr>
         </thead>
         <tbody>


         <tr id="/definitions/maps" class="property">
                 <th class="col-md-4">
                 <a href="#/definitions/maps">maps</a>
             </th>
             <td class="col-md-4">
                         <div><span class="type">array</span> [</div>


             <div class="items-anyOf">
                     <a href="../Types/RegisterType_schema.html" class="schema_link">Types.RegisterType</a>
             </div>
             <div class="items-anyOf">
                     <a href="../AST/Identifier_schema.html" class="schema_link">AST.Identifier</a>
             </div>
             <div class="items-anyOf">
                     <a href="../AST/DotAtom_schema.html" class="schema_link">AST.DotAtom</a>
             </div>
             <div class="items-anyOf">
                     <a href="../AST/SquareOp_schema.html" class="schema_link">AST.SquareOp</a>
             </div>


                             <div>]</div>
             </td>
             <td class="col-md-4">
                     <div><p>A list of items that map to one another.</p>
 <p>Individual mapped bit(s) can be defined in the slices property of the
 given items. Note if <code>A[10, 5:0]</code> maps to B (no range specified),
 then it is implied that <code>A[10, 5:0]</code> maps to <code>B[6:0]</code>.</p></div>


             </td>
         </tr>

         </tbody>
     </table>
 </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>
         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.Map</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/maps" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/maps">maps<sup>&loz;</sup></a>
             </th>
             <td class="col-md-4">
                     <a href="#/definitions/maps" class="schema_link"></a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="#/definitions/maps" class="schema_link">definitions.maps</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>&loz; Required</dt>
                             <dd>Properties marked with &loz; are required properties.</dd>
                         </dl>
                     </td>
                 </tr>
         </tbody>
     </table>


             <!-- array, and it has described items -->
     </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">{
   "type": "object",
   "additionalProperties": false,
   "definitions": {
     "maps": {
       "info": [
         "A list of items that map to one another.",
         [
           "Individual mapped bit(s) can be defined in the slices property of the ",
           "given items. Note if `A[10, 5:0]` maps to B (no range specified), ",
           "then it is implied that `A[10, 5:0]` maps to `B[6:0]`."
         ]
       ],
       "type": "array",
       "minItems": 2,
       "items": {
         "anyOf": [
           {
             "$ref": "../Types/RegisterType.json"
           },
           {
             "$ref": "../AST/Identifier.json"
           },
           {
             "$ref": "../AST/DotAtom.json"
           },
           {
             "$ref": "../AST/SquareOp.json"
           }
         ]
       }
     }
   },
   "info": [
     "`Map` provides a bi-directional mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers.",
     [
       "For example, if the maps property lists `REGBLOCK1.REG1`, `REGBLOCK1.REG2` and",
       "`AArch32-ACTRL`, then there exists a bidirectional mapping between all three items."
     ]
   ],
   "properties": {
     "_type": {
       "enum": [
         "Mapping.Map"
       ]
     },
     "_meta": {
       "$ref": "../Meta.json"
     },
     "condition": {
       "$ref": "../Traits/HasCondition.json#/definitions/condition",
       "info": [
         "This condition must be true for the mapping to exist."
       ]
     },
     "maps": {
       "$ref": "#/definitions/maps"
     }
   },
   "required": [
     "maps"
   ],
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Map"
 }</code></pre>
 </div>

     </div>

     <div class="container">
         <div class="footer text-right">
             Copyright &copy; 2024 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>
	<!-- 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>Map - ARM Machine Readable Schema - 2.5.5</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.5.5</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">Mapping.</span><span class=" title-type">Map</span>

	<!-- if oneOf is set, then type is ignored -->
	<span class="type">object</span>
	</h2>




	<div class="static-markdown"><p><code>Map</code> provides a bi-directional mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers.</p>
	<p>For example, if the maps property lists <code>REGBLOCK1.REG1</code>, <code>REGBLOCK1.REG2</code> and
	<code>AArch32-ACTRL</code>, then there exists a bidirectional mapping between all three items.</p></div>
	</div>

	<!-- definitions -->
	<div class="row">
	<h3><span class="type Xof">definition</span></h3>
	<table class="table table-hover definitions">
	<thead>
	<tr>
	<th class="col-md-4">Definitions</th>
	<th class="col-md-4">Type</th>
	<th class="col-md-4">Description</th>
	</tr>
	</thead>
	<tbody>


	<tr id="/definitions/maps" class="property">
	<th class="col-md-4">
	<a href="#/definitions/maps">maps</a>
	</th>
	<td class="col-md-4">
	<div><span class="type">array</span> [</div>




	<div class="items-anyOf">
	<a href="../Types/RegisterType_schema.html" class="schema_link">Types.RegisterType</a>
	</div>
	<div class="items-anyOf">
	<a href="../AST/Identifier_schema.html" class="schema_link">AST.Identifier</a>
	</div>
	<div class="items-anyOf">
	<a href="../AST/DotAtom_schema.html" class="schema_link">AST.DotAtom</a>
	</div>
	<div class="items-anyOf">
	<a href="../AST/SquareOp_schema.html" class="schema_link">AST.SquareOp</a>
	</div>


	<div>]</div>
	</td>
	<td class="col-md-4">
	<div><p>A list of items that map to one another.</p>
	<p>Individual mapped bit(s) can be defined in the slices property of the
	given items. Note if <code>A[10, 5:0]</code> maps to B (no range specified),
	then it is implied that <code>A[10, 5:0]</code> maps to <code>B[6:0]</code>.</p></div>



	</td>
	</tr>

	</tbody>
	</table>
	</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>
	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.Map</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/maps" class="property">
	<th class="col-md-4">
	<a href="#/properties/maps">maps<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<a href="#/definitions/maps" class="schema_link"></a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="#/definitions/maps" class="schema_link">definitions.maps</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>&loz; Required</dt>
	<dd>Properties marked with &loz; are required properties.</dd>
	</dl>
	</td>
	</tr>
	</tbody>
	</table>




	<!-- array, and it has described items -->
	</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">{
	"type": "object",
	"additionalProperties": false,
	"definitions": {
	"maps": {
	"info": [
	"A list of items that map to one another.",
	[
	"Individual mapped bit(s) can be defined in the slices property of the ",
	"given items. Note if `A[10, 5:0]` maps to B (no range specified), ",
	"then it is implied that `A[10, 5:0]` maps to `B[6:0]`."
	]
	],
	"type": "array",
	"minItems": 2,
	"items": {
	"anyOf": [
	{
	"$ref": "../Types/RegisterType.json"
	},
	{
	"$ref": "../AST/Identifier.json"
	},
	{
	"$ref": "../AST/DotAtom.json"
	},
	{
	"$ref": "../AST/SquareOp.json"
	}
	]
	}
	}
	},
	"info": [
	"`Map` provides a bi-directional mapping between Registers, RegisterBlocks, and Field types and individual bits within Registers.",
	[
	"For example, if the maps property lists `REGBLOCK1.REG1`, `REGBLOCK1.REG2` and",
	"`AArch32-ACTRL`, then there exists a bidirectional mapping between all three items."
	]
	],
	"properties": {
	"_type": {
	"enum": [
	"Mapping.Map"
	]
	},
	"_meta": {
	"$ref": "../Meta.json"
	},
	"condition": {
	"$ref": "../Traits/HasCondition.json#/definitions/condition",
	"info": [
	"This condition must be true for the mapping to exist."
	]
	},
	"maps": {
	"$ref": "#/definitions/maps"
	}
	},
	"required": [
	"maps"
	],
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "Map"
	}</code></pre>
	</div>

	</div>

	<div class="container">
	<div class="footer text-right">
	Copyright © 2024 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>