Google Git
Sign in
kernel / pub / scm / linux / kernel / git / maz / AARCHMRS / HEAD / . / docs / Fields / Array_schema.html
blob: 6da650f919bd30e6dd944b184a4a31340fbc124d [file] [log] [blame]
<!-- 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>Array - ARM Machine Readable Schema - 2.7.1</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.7.1</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">Fields.</span><span class=" title-type">Array</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>Field array is a rolled up representation of an array of fields.
Architecturally this should be treated the same as a set of unrolled fields.</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>
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>Fields.Array</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/access" class="property">
<th class="col-md-4">
<a href="#/properties/access">access</a>
</th>
<td class="col-md-4">
<a href="../Traits/HasFieldAccess_schema.html#/definitions/access" class="schema_link">Traits.HasFieldAccess</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Traits/HasFieldAccess_schema.html#/definitions/access" class="schema_link">definitions.access</a> in
<a href="../Traits/HasFieldAccess_schema.html#/definitions/access" class="schema_link">Traits.HasFieldAccess</a>
for more information.
</div>
<div>
<b>Default</b>
<pre class="schema-json"><code class="language-json">null</code></pre>
</div>
</td>
</tr>
<tr id="/properties/description" class="property">
<th class="col-md-4">
<a href="#/properties/description">description</a>
</th>
<td class="col-md-4">
<a href="../Traits/HasDescription_schema.html#/definitions/description" class="schema_link">Traits.HasDescription</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/description" class="schema_link">properties.description</a> in
<a href="../Fields/Field_schema.html#/properties/description" class="schema_link">Fields.Field</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/display" class="property">
<th class="col-md-4">
<a href="#/properties/display">display</a>
</th>
<td class="col-md-4">
<ul class="inline list-type">
<li class="inline type">string</li>
<li class="inline type">null</li>
</ul>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/display" class="schema_link">properties.display</a> in
<a href="../Fields/Field_schema.html#/properties/display" class="schema_link">Fields.Field</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>&loz;</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>&loz;</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/name" class="property">
<th class="col-md-4">
<a href="#/properties/name">name<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<ul class="inline list-type">
<li class="inline type">string</li>
<li class="inline type">null</li>
</ul>
</td>
<td class="col-md-4">
<div><p>The name must include a <code>&lt;[^&lt;]+&gt;</code> which is used to represent the index value of the field.</p>
<p>For example, unrolling a field named <code>F&lt;x&gt;</code> with indexes <code>4:2</code>
will yield three fields with the names <code>F4</code>, <code>F3</code>, <code>F2</code> in that order.</p>
<p>Below are few other examples on how a name property could be defined:</p></div>
<div>
See
<a href="../Fields/Field_schema.html#/properties/name" class="schema_link">properties.name</a> in
<a href="../Fields/Field_schema.html#/properties/name" class="schema_link">Fields.Field</a>
for more information.
</div>
<dl>
<dt>Pattern</dt>
<dd><code title="Regex">/&lt;[^&lt;]+&gt;/</code></dd>
</dl>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">&#34;F&lt;x&gt;&#34;</code></pre>
<pre class="schema-json"><code class="language-json">&#34;Part&lt;x&gt;_Q&#34;</code></pre>
</div>
</td>
</tr>
<tr id="/properties/rangeset" class="property">
<th class="col-md-4">
<a href="#/properties/rangeset">rangeset<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<a href="../Rangeset_schema.html" class="schema_link">Rangeset</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/rangeset" class="schema_link">properties.rangeset</a> in
<a href="../Fields/Field_schema.html#/properties/rangeset" class="schema_link">Fields.Field</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/resets" class="property">
<th class="col-md-4">
<a href="#/properties/resets">resets</a>
</th>
<td class="col-md-4">
<a href="../FieldResets_schema.html" class="schema_link">FieldResets</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/resets" class="schema_link">properties.resets</a> in
<a href="../Fields/Field_schema.html#/properties/resets" class="schema_link">Fields.Field</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/values" class="property">
<th class="col-md-4">
<a href="#/properties/values">values</a>
</th>
<td class="col-md-4">
<a href="../Valuesets/ValuesetAbstract_schema.html#/definitions/children" class="schema_link">Valuesets.ValuesetAbstract</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/values" class="schema_link">properties.values</a> in
<a href="../Fields/Field_schema.html#/properties/values" class="schema_link">Fields.Field</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/volatile" class="property">
<th class="col-md-4">
<a href="#/properties/volatile">volatile</a>
</th>
<td class="col-md-4">
<ul class="inline list-type">
<li class="inline type">boolean</li>
</ul>
</td>
<td class="col-md-4">
<div>
See
<a href="../Fields/Field_schema.html#/properties/volatile" class="schema_link">properties.volatile</a> in
<a href="../Fields/Field_schema.html#/properties/volatile" class="schema_link">Fields.Field</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>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Fields.Array&#34;,
&#34;name&#34;: &#34;F&lt;x&gt;&#34;,
&#34;description&#34;: {
&#34;after&#34;: null,
&#34;before&#34;: &#34;A short way of writing many 2 bit fields: F3 at 7:6, F2 at 5:4, F1 at 3:2 and, F0 at 1:0&#34;
},
&#34;rangeset&#34;: [
{
&#34;_type&#34;: &#34;Range&#34;,
&#34;start&#34;: 0,
&#34;width&#34;: 8
}
],
&#34;indexes&#34;: [
{
&#34;_type&#34;: &#34;Range&#34;,
&#34;start&#34;: 0,
&#34;width&#34;: 4
}
],
&#34;index_variable&#34;: &#34;x&#34;,
&#34;values&#34;: {
&#34;_type&#34;: &#34;Valuesets.Values&#34;,
&#34;values&#34;: [
{
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;meaning&#34;: &#34;The first value of every F&amp;lt;x&amp;gt; field&#34;,
&#34;value&#34;: &#34;&#39;01&#39;&#34;
},
{
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;meaning&#34;: &#34;The second value of every F&amp;lt;x&amp;gt; field&#34;,
&#34;value&#34;: &#34;&#39;00&#39;&#34;
}
]
},
&#34;access&#34;: [
{
&#34;_type&#34;: &#34;Accessors.Permission.FieldAccess&#34;,
&#34;condition&#34;: {
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;x&#34;
},
&#34;op&#34;: &#34;&lt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.Function&#34;,
&#34;arguments&#34;: [
{
&#34;_type&#34;: &#34;Types.Field&#34;,
&#34;value&#34;: {
&#34;field&#34;: &#34;CG1NC&#34;,
&#34;instance&#34;: null,
&#34;name&#34;: &#34;AMCGCR_EL0&#34;,
&#34;slices&#34;: null,
&#34;state&#34;: &#34;AArch64&#34;
}
}
],
&#34;name&#34;: &#34;UInt&#34;
}
},
&#34;access&#34;: &#34;RW&#34;
},
{
&#34;_type&#34;: &#34;Accessors.Permission.FieldAccess&#34;,
&#34;condition&#34;: {
&#34;_type&#34;: &#34;AST.Bool&#34;,
&#34;value&#34;: true
},
&#34;access&#34;: &#34;RES0&#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">{
"info": [
[
"Field array is a rolled up representation of an array of fields.",
"Architecturally this should be treated the same as a set of unrolled fields."
]
],
"examples": [
{
"_type": "Fields.Array",
"name": "F<x>",
"description": {
"after": null,
"before": "A short way of writing many 2 bit fields: F3 at 7:6, F2 at 5:4, F1 at 3:2 and, F0 at 1:0"
},
"rangeset": [
{
"_type": "Range",
"start": 0,
"width": 8
}
],
"indexes": [
{
"_type": "Range",
"start": 0,
"width": 4
}
],
"index_variable": "x",
"values": {
"_type": "Valuesets.Values",
"values": [
{
"_type": "Values.Value",
"meaning": "The first value of every F&lt;x&gt; field",
"value": "'01'"
},
{
"_type": "Values.Value",
"meaning": "The second value of every F&lt;x&gt; field",
"value": "'00'"
}
]
},
"access": [
{
"_type": "Accessors.Permission.FieldAccess",
"condition": {
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "x"
},
"op": "<",
"right": {
"_type": "AST.Function",
"arguments": [
{
"_type": "Types.Field",
"value": {
"field": "CG1NC",
"instance": null,
"name": "AMCGCR_EL0",
"slices": null,
"state": "AArch64"
}
}
],
"name": "UInt"
}
},
"access": "RW"
},
{
"_type": "Accessors.Permission.FieldAccess",
"condition": {
"_type": "AST.Bool",
"value": true
},
"access": "RES0"
}
]
}
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Fields.Array"
]
},
"access": {
"default": null,
"$ref": "../Traits/HasFieldAccess.json#/definitions/access"
},
"description": {
"see": "../Fields/Field.json",
"$ref": "../Traits/HasDescription.json#/definitions/description"
},
"display": {
"see": "../Fields/Field.json",
"type": [
"string",
"null"
]
},
"name": {
"see": "../Fields/Field.json",
"info": [
"The name must include a `<[^<]+>` which is used to represent the index value of the field.",
[
"For example, unrolling a field named `F<x>` with indexes `4:2`",
" will yield three fields with the names `F4`, `F3`, `F2` in that order."
],
"Below are few other examples on how a name property could be defined:"
],
"examples": [
"F<x>",
"Part<x>_Q"
],
"pattern": "<[^<]+>",
"type": [
"string",
"null"
]
},
"volatile": {
"see": "../Fields/Field.json",
"type": "boolean"
},
"rangeset": {
"see": "../Fields/Field.json",
"$ref": "../Rangeset.json"
},
"resets": {
"see": "../Fields/Field.json",
"$ref": "../FieldResets.json"
},
"indexes": {
"$ref": "../Traits/HasIndexes.json#/definitions/indexes"
},
"index_variable": {
"$ref": "../Traits/HasIndexes.json#/definitions/index_variable"
},
"values": {
"$ref": "../Valuesets/ValuesetAbstract.json#/definitions/children",
"see": "../Fields/Field.json"
}
},
"required": [
"name",
"rangeset",
"indexes",
"index_variable"
],
"title": "Array",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"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>