| <!-- 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>Fieldset - ARM Machine Readable Schema - 2.7.4</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.4</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-type">Fieldset</span> |
| |
| <!-- if oneOf is set, then type is ignored --> |
| <span class="type">object</span> |
| </h2> |
| |
| |
| |
| |
| <div class="static-markdown"><p>A Fieldset provides a container for an array of fields.</p> |
| <p>If a fieldset is used inside an context of an array, then the condition property is used |
| to define conditional layouts.</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>Fieldset</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>The condition that must be true for this fieldset to be present.</p> |
| <p>Conditions are unique when <code>Fieldset</code> are used inside an array container, |
| this is because two field layouts with the same condition cannot coexist.</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/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><p>The descriptive text, which is used to identify information about the <code>Fieldset</code>.</p></div> |
| |
| <div> |
| See |
| <a href="Traits/HasDescription_schema.html#/definitions/description" class="schema_link">definitions.description</a> in |
| <a href="Traits/HasDescription_schema.html#/definitions/description" class="schema_link">Traits.HasDescription</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><p>A short display name of the <code>Fieldset</code>.</p></div> |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/name" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/name">name</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>A named identifier used for referencing a <code>Fieldset</code>.</p></div> |
| <dl> |
| <dt>Pattern</dt> |
| <dd><code title="Regex">/^[A-Za-z][A-Za-z0-9_]*$/</code></dd> |
| </dl> |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/values" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/values">values<sup>◊</sup></a> |
| </th> |
| <td class="col-md-4"> |
| <div><span class="type">array</span> [</div> |
| |
| |
| |
| |
| <div class="items-oneOf"> |
| <a href="Fields/Field_schema.html" class="schema_link">Fields.Field</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/Reserved_schema.html" class="schema_link">Fields.Reserved</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/ReservedInternal_schema.html" class="schema_link">Fields.ReservedInternal</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/ImplementationDefined_schema.html" class="schema_link">Fields.ImplementationDefined</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/Array_schema.html" class="schema_link">Fields.Array</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/Vector_schema.html" class="schema_link">Fields.Vector</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/ConditionalField_schema.html" class="schema_link">Fields.ConditionalField</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/ConstantField_schema.html" class="schema_link">Fields.ConstantField</a> |
| </div> |
| <div class="items-oneOf"> |
| <a href="Fields/Dynamic_schema.html" class="schema_link">Fields.Dynamic</a> |
| </div> |
| |
| |
| <div>]</div> |
| </td> |
| <td class="col-md-4"> |
| <div><p>An array of fields that, when considered together, compose the fieldset.</p> |
| <p>The ranges of all the fields in a fieldset must sum to the width of the fieldset, |
| and all named fields (as an example, see <a href="Fields/Field_schema.html">Field</a> which has a named property) must be unique within a Fieldset.</p></div> |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/properties/width" class="property"> |
| <th class="col-md-4"> |
| <a href="#/properties/width">width<sup>◊</sup></a> |
| </th> |
| <td class="col-md-4"> |
| <ul class="inline list-type"> |
| <li class="inline type">integer</li> |
| </ul> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The count of bits that this fieldset spans. |
| This will typically be 32 or 64 bits in an ARM implementation, |
| but Fieldset supports any integer value greater than 0.</p></div> |
| <dl> |
| <dt>Minimum</dt> |
| <dd>1</dd> |
| </dl> |
| |
| |
| |
| </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": "Fieldset", |
| "condition": { |
| "_type": "AST.Function", |
| "arguments": [ |
| { |
| "_type": "AST.Identifier", |
| "value": "MY_FEAT" |
| } |
| ], |
| "name": "IsFeatureImplemented" |
| }, |
| "width": 32, |
| "description": { |
| "_type": "Description", |
| "after": null, |
| "before": "A 32-bit fieldset" |
| }, |
| "values": [ |
| { |
| "_type": "Fields.Reserved", |
| "rangeset": [ |
| { |
| "_type": "Range", |
| "start": 2, |
| "width": 30 |
| } |
| ], |
| "value": "RES0" |
| }, |
| { |
| "_type": "Fields.Field", |
| "name": "F1", |
| "description": { |
| "_type": "Description", |
| "after": null, |
| "before": "A 2-bit filed" |
| }, |
| "rangeset": [ |
| { |
| "_type": "Range", |
| "start": 0, |
| "width": 2 |
| } |
| ] |
| } |
| ] |
| }</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">{ |
| "additionalProperties": false, |
| "info": [ |
| "A Fieldset provides a container for an array of fields.", |
| [ |
| "If a fieldset is used inside an context of an array, then the condition property is used", |
| "to define conditional layouts." |
| ] |
| ], |
| "properties": { |
| "_meta": { |
| "$ref": "Meta.json", |
| "info": [ |
| "Metadata" |
| ] |
| }, |
| "_type": { |
| "enum": [ |
| "Fieldset" |
| ] |
| }, |
| "condition": { |
| "$ref": "Traits/HasCondition.json#/definitions/condition", |
| "info": [ |
| "The condition that must be true for this fieldset to be present.", |
| [ |
| "Conditions are unique when `Fieldset` are used inside an array container, ", |
| "this is because two field layouts with the same condition cannot coexist." |
| ] |
| ] |
| }, |
| "description": { |
| "$ref": "Traits/HasDescription.json#/definitions/description", |
| "info": [ |
| "The descriptive text, which is used to identify information about the `Fieldset`." |
| ] |
| }, |
| "name": { |
| "type": [ |
| "string", |
| "null" |
| ], |
| "pattern": "^[A-Za-z][A-Za-z0-9_]*$", |
| "info": [ |
| "A named identifier used for referencing a `Fieldset`." |
| ] |
| }, |
| "display": { |
| "type": [ |
| "string", |
| "null" |
| ], |
| "info": [ |
| "A short display name of the `Fieldset`." |
| ] |
| }, |
| "values": { |
| "additionalItems": false, |
| "info": [ |
| "An array of fields that, when considered together, compose the fieldset.", |
| [ |
| "The ranges of all the fields in a fieldset must sum to the width of the fieldset, ", |
| "and all named fields (as an example, see [Field](Fields/Field_schema.html) which has a named property) must be unique within a Fieldset." |
| ] |
| ], |
| "items": { |
| "oneOf": [ |
| { |
| "$ref": "Fields/Field.json" |
| }, |
| { |
| "$ref": "Fields/Reserved.json" |
| }, |
| { |
| "$ref": "Fields/ReservedInternal.json" |
| }, |
| { |
| "$ref": "Fields/ImplementationDefined.json" |
| }, |
| { |
| "$ref": "Fields/Array.json" |
| }, |
| { |
| "$ref": "Fields/Vector.json" |
| }, |
| { |
| "$ref": "Fields/ConditionalField.json" |
| }, |
| { |
| "$ref": "Fields/ConstantField.json" |
| }, |
| { |
| "$ref": "Fields/Dynamic.json" |
| } |
| ] |
| }, |
| "type": "array" |
| }, |
| "width": { |
| "info": [ |
| [ |
| "The count of bits that this fieldset spans.", |
| "This will typically be 32 or 64 bits in an ARM implementation,", |
| "but Fieldset supports any integer value greater than 0." |
| ] |
| ], |
| "minimum": 1, |
| "type": "integer" |
| } |
| }, |
| "required": [ |
| "width", |
| "values" |
| ], |
| "title": "Fieldset", |
| "type": "object", |
| "examples": [ |
| { |
| "_type": "Fieldset", |
| "condition": { |
| "_type": "AST.Function", |
| "arguments": [ |
| { |
| "_type": "AST.Identifier", |
| "value": "MY_FEAT" |
| } |
| ], |
| "name": "IsFeatureImplemented" |
| }, |
| "width": 32, |
| "description": { |
| "_type": "Description", |
| "after": null, |
| "before": "A 32-bit fieldset" |
| }, |
| "values": [ |
| { |
| "_type": "Fields.Reserved", |
| "rangeset": [ |
| { |
| "_type": "Range", |
| "start": 2, |
| "width": 30 |
| } |
| ], |
| "value": "RES0" |
| }, |
| { |
| "_type": "Fields.Field", |
| "name": "F1", |
| "description": { |
| "_type": "Description", |
| "after": null, |
| "before": "A 2-bit filed" |
| }, |
| "rangeset": [ |
| { |
| "_type": "Range", |
| "start": 0, |
| "width": 2 |
| } |
| ] |
| } |
| ] |
| } |
| ], |
| "$schema": "http://json-schema.org/draft-04/schema#" |
| }</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> |