docs/Fields/ConditionalField_schema.html - pub/scm/linux/kernel/git/maz/AARCHMRS - Git at Google


            
            <!-- 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>ConditionalField - 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">&nlarr; Home</div></a>

            
                    </div>

            
                </div>


                <div class="container">


            <div class="row">


                    <h2>

            
                            <span class="title-namespace">Fields.</span><span class=" title-type">ConditionalField</span>


                        <!-- if oneOf is set, then type is ignored -->

            
                            <span class="type">object</span>

            
                    </h2>


                <div class="static-markdown"><p>The ConditionalField is used to specify a field which has different properties under different conditions.</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.ConditionalField</code>

            
                                    </dd>

            
                                </dl>


                        </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>Provides the description of this conditional field.</p></div>


                <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/fields" class="property">

            
                            <th class="col-md-4">

            
                            <a href="#/properties/fields">fields<sup>&loz;</sup></a>

            
                        </th>

            
                        <td class="col-md-4">

            
                                    <div><span class="type">array</span> [</div>


                                        <div>]</div>

            
                        </td>

            
                        <td class="col-md-4">

            
                                <div><p>A list of objects with a field and condition, where the ConditionalField can resolve to one of the fields. Each field is accompanied by a condition to indicate when this field applies.</p>

            
            <p>The objects are resolved sequentially, meaning the ConditionalField resolves to the first field with a condition that evaluates True. If all conditions are False then the default reserved_type property is used as a shorthand.</p>

            
            <p>If a condition is null, then that Field will be considered the default.</p>

            
            <p><strong>WARNING</strong>: Since conditions are resolved sequentially the default (null) condition should be last.</p>

            
            <p>Also note that the rangeset of the individual fields should be set relative

            
            the <code>ConditionalField</code> rangeset. For example, if the ConditionalField's

            
            <a href="../Rangeset_schema.html">Rangeset</a> is <code>30:25</code>, then all internal fields should

            
            have ranges <code>5:0</code>.</p>

            
            <p>Further note that a ConditionalField could resolve to a field or a list of fields (limited to all field types except Vectors and Arrays).</p>

            
            <p>This is primarily to allow an Array or Vector to be replaced by a the list of fields they create when expanded.</p></div>


                    <h5>Examples</h5>

            
                    <div>

            
                        <pre class="schema-json"><code class="language-json">[

            
                {

            
                    &#34;condition&#34;: {

            
                        &#34;_type&#34;: &#34;AST.Function&#34;,

            
                        &#34;arguments&#34;: [

            
                            {

            
                                &#34;_type&#34;: &#34;AST.Identifier&#34;,

            
                                &#34;value&#34;: &#34;MYFEATURE&#34;

            
                            }

            
                        ],

            
                        &#34;name&#34;: &#34;IsFeatureImplemented&#34;

            
                    },

            
                    &#34;field&#34;: {

            
                        &#34;_type&#34;: &#34;Fields.Field&#34;,

            
                        &#34;name&#34;: &#34;F1&#34;,

            
                        &#34;rangeset&#34;: [

            
                            {

            
                                &#34;_type&#34;: &#34;Range&#34;,

            
                                &#34;start&#34;: 0,

            
                                &#34;width&#34;: 2

            
                            }

            
                        ],

            
                        &#34;description&#34;: {

            
                            &#34;_type&#34;: &#34;Description&#34;,

            
                            &#34;after&#34;: null,

            
                            &#34;before&#34;: &#34;A field that exist when MYFEATURE is implemented&#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;First value&#34;,

            
                                    &#34;value&#34;: &#34;&#39;00&#39;&#34;

            
                                },

            
                                {

            
                                    &#34;_type&#34;: &#34;Values.Value&#34;,

            
                                    &#34;meaning&#34;: &#34;Second value&#34;,

            
                                    &#34;value&#34;: &#34;&#39;10&#39;&#34;

            
                                }

            
                            ]

            
                        }

            
                    }

            
                },

            
                {

            
                    &#34;condition&#34;: null,

            
                    &#34;field&#34;: {

            
                        &#34;_type&#34;: &#34;Fields.Field&#34;,

            
                        &#34;name&#34;: &#34;F1&#34;,

            
                        &#34;rangeset&#34;: [

            
                            {

            
                                &#34;_type&#34;: &#34;Range&#34;,

            
                                &#34;start&#34;: 0,

            
                                &#34;width&#34;: 2

            
                            }

            
                        ],

            
                        &#34;description&#34;: {

            
                            &#34;_type&#34;: &#34;Description&#34;,

            
                            &#34;after&#34;: null,

            
                            &#34;before&#34;: [

            
                                [

            
                                    &#34;A field that exists when all previous conditions fail. &#34;,

            
                                    &#34;In this case, this field exists when &#34;,

            
                                    &#34;MYFEATURE is not implemented&#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;First value&#34;,

            
                                    &#34;value&#34;: &#34;&#39;00&#39;&#34;

            
                                },

            
                                {

            
                                    &#34;_type&#34;: &#34;Values.Value&#34;,

            
                                    &#34;meaning&#34;: &#34;Second value&#34;,

            
                                    &#34;value&#34;: &#34;&#39;10&#39;&#34;

            
                                }

            
                            ]

            
                        }

            
                    }

            
                }

            
            ]</code></pre>

            
                    </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>

            
                    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>


                        </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/reservedtype" class="property">

            
                            <th class="col-md-4">

            
                            <a href="#/properties/reservedtype">reservedtype<sup>&loz;</sup></a>

            
                        </th>

            
                        <td class="col-md-4">

            
                                <a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</a>

            
                        </td>

            
                        <td class="col-md-4">

            
                                <div><p>If no default conditional field is represented, then a Reserved field with the

            
            value of <code>reservedtype</code> is used to define the default case.</p></div>


                <div>

            
                    See

            
                        <a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</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/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.ConditionalField&#34;,

            
                &#34;name&#34;: &#34;FOO&#34;,

            
                &#34;rangeset&#34;: [

            
                    {

            
                        &#34;_type&#34;: &#34;Range&#34;,

            
                        &#34;start&#34;: 10,

            
                        &#34;width&#34;: 11

            
                    }

            
                ],

            
                &#34;description&#34;: {

            
                    &#34;_type&#34;: &#34;Description&#34;,

            
                    &#34;after&#34;: null,

            
                    &#34;before&#34;: [

            
                        [

            
                            &#34;A conditional field, where the field F1 (when MYFEATURE is implemented)&#34;,

            
                            &#34;is located at 11:10 (absolute position), and bits 20:12 are RES0 due&#34;,

            
                            &#34;to the reservedtype property.&#34;

            
                        ],

            
                        [

            
                            &#34;When MYFEATURE is not implemented then bits 20:10 are RES0 which comes&#34;,

            
                            &#34;from the reservedtype&#34;

            
                        ]

            
                    ]

            
                },

            
                &#34;fields&#34;: [

            
                    {

            
                        &#34;condition&#34;: {

            
                            &#34;_type&#34;: &#34;AST.Function&#34;,

            
                            &#34;arguments&#34;: [

            
                                {

            
                                    &#34;_type&#34;: &#34;AST.Identifier&#34;,

            
                                    &#34;value&#34;: &#34;MYFEATURE&#34;

            
                                }

            
                            ],

            
                            &#34;name&#34;: &#34;IsFeatureImplemented&#34;

            
                        },

            
                        &#34;field&#34;: {

            
                            &#34;_type&#34;: &#34;Fields.Field&#34;,

            
                            &#34;name&#34;: &#34;F1&#34;,

            
                            &#34;rangeset&#34;: [

            
                                {

            
                                    &#34;_type&#34;: &#34;Range&#34;,

            
                                    &#34;start&#34;: 0,

            
                                    &#34;width&#34;: 2

            
                                }

            
                            ],

            
                            &#34;description&#34;: {

            
                                &#34;_type&#34;: &#34;Description&#34;,

            
                                &#34;after&#34;: null,

            
                                &#34;before&#34;: &#34;A field that exists when MYFEATURE is implemented&#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;First value&#34;,

            
                                        &#34;value&#34;: &#34;&#39;00&#39;&#34;

            
                                    },

            
                                    {

            
                                        &#34;_type&#34;: &#34;Values.Value&#34;,

            
                                        &#34;meaning&#34;: &#34;Second value&#34;,

            
                                        &#34;value&#34;: &#34;&#39;10&#39;&#34;

            
                                    }

            
                                ]

            
                            }

            
                        }

            
                    }

            
                ],

            
                &#34;reservedtype&#34;: &#34;RES0&#34;

            
            }</code></pre>

            
                        <pre class="schema-json"><code class="language-json">{

            
                &#34;_type&#34;: &#34;Fields.ConditionalField&#34;,

            
                &#34;name&#34;: &#34;BAR&#34;,

            
                &#34;rangeset&#34;: [

            
                    {

            
                        &#34;_type&#34;: &#34;Range&#34;,

            
                        &#34;start&#34;: 20,

            
                        &#34;width&#34;: 10

            
                    }

            
                ],

            
                &#34;description&#34;: {

            
                    &#34;_type&#34;: &#34;Description&#34;,

            
                    &#34;after&#34;: null,

            
                    &#34;before&#34;: [

            
                        [

            
                            &#34;A conditional field, which resolves to a list of fields.&#34;,

            
                            &#34;The field F1&#39;s rangeset will change to 23:20 and the field F2&#39;s rangeset&#34;,

            
                            &#34;will change to 29:26 after the conditional field is resolved.&#34;,

            
                            &#34;The remaning rangeset of 25:24, will be filled with RES0.&#34;

            
                        ]

            
                    ]

            
                },

            
                &#34;fields&#34;: [

            
                    {

            
                        &#34;condition&#34;: {

            
                            &#34;_type&#34;: &#34;AST.Bool&#34;,

            
                            &#34;value&#34;: true

            
                        },

            
                        &#34;field&#34;: [

            
                            {

            
                                &#34;_type&#34;: &#34;Fields.Field&#34;,

            
                                &#34;name&#34;: &#34;F1&#34;,

            
                                &#34;rangeset&#34;: [

            
                                    {

            
                                        &#34;_type&#34;: &#34;Range&#34;,

            
                                        &#34;start&#34;: 0,

            
                                        &#34;width&#34;: 4

            
                                    }

            
                                ],

            
                                &#34;description&#34;: {

            
                                    &#34;_type&#34;: &#34;Description&#34;,

            
                                    &#34;after&#34;: null,

            
                                    &#34;before&#34;: &#34;After resolving, this field&#39;s rangeset becomes 23:20&#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;First value&#34;,

            
                                            &#34;value&#34;: &#34;&#39;00&#39;&#34;

            
                                        },

            
                                        {

            
                                            &#34;_type&#34;: &#34;Values.Value&#34;,

            
                                            &#34;meaning&#34;: &#34;Second value&#34;,

            
                                            &#34;value&#34;: &#34;&#39;10&#39;&#34;

            
                                        }

            
                                    ]

            
                                }

            
                            },

            
                            {

            
                                &#34;_type&#34;: &#34;Fields.Field&#34;,

            
                                &#34;name&#34;: &#34;F2&#34;,

            
                                &#34;rangeset&#34;: [

            
                                    {

            
                                        &#34;_type&#34;: &#34;Range&#34;,

            
                                        &#34;start&#34;: 6,

            
                                        &#34;width&#34;: 4

            
                                    }

            
                                ],

            
                                &#34;description&#34;: {

            
                                    &#34;_type&#34;: &#34;Description&#34;,

            
                                    &#34;after&#34;: null,

            
                                    &#34;before&#34;: &#34;After resolving, this field&#39;s rangeset becomes 29:26&#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;First value&#34;,

            
                                            &#34;value&#34;: &#34;&#39;00&#39;&#34;

            
                                        },

            
                                        {

            
                                            &#34;_type&#34;: &#34;Values.Value&#34;,

            
                                            &#34;meaning&#34;: &#34;Second value&#34;,

            
                                            &#34;value&#34;: &#34;&#39;10&#39;&#34;

            
                                        }

            
                                    ]

            
                                }

            
                            }

            
                        ]

            
                    }

            
                ],

            
                &#34;reservedtype&#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": [

            
                "The ConditionalField is used to specify a field which has different properties under different conditions."

            
              ],

            
              "properties": {

            
                "_meta": {

            
                  "$ref": "../Meta.json"

            
                },

            
                "_type": {

            
                  "enum": [

            
                    "Fields.ConditionalField"

            
                  ]

            
                },

            
                "description": {

            
                  "info": [

            
                    "Provides the description of this conditional field."

            
                  ],

            
                  "$ref": "../Traits/HasDescription.json#/definitions/description",

            
                  "see": "../Fields/Field.json"

            
                },

            
                "display": {

            
                  "see": "../Fields/Field.json",

            
                  "type": [

            
                    "string",

            
                    "null"

            
                  ]

            
                },

            
                "fields": {

            
                  "additionalItems": false,

            
                  "info": [

            
                    "A list of objects with a field and condition, where the ConditionalField can resolve to one of the fields. Each field is accompanied by a condition to indicate when this field applies.",

            
                    "The objects are resolved sequentially, meaning the ConditionalField resolves to the first field with a condition that evaluates True. If all conditions are False then the default reserved_type property is used as a shorthand.",

            
                    "If a condition is null, then that Field will be considered the default.",

            
                    "**WARNING**: Since conditions are resolved sequentially the default (null) condition should be last.",

            
                    [

            
                      "Also note that the rangeset of the individual fields should be set relative ",

            
                      "the `ConditionalField` rangeset. For example, if the ConditionalField's ",

            
                      "[Rangeset](../Rangeset_schema.html) is `30:25`, then all internal fields should ",

            
                      "have ranges `5:0`."

            
                    ],

            
                    "Further note that a ConditionalField could resolve to a field or a list of fields (limited to all field types except Vectors and Arrays).",

            
                    "This is primarily to allow an Array or Vector to be replaced by a the list of fields they create when expanded."

            
                  ],

            
                  "items": {

            
                    "additionalProperties": false,

            
                    "properties": {

            
                      "condition": {

            
                        "$ref": "../Traits/HasCondition.json#/definitions/condition"

            
                      },

            
                      "field": {

            
                        "oneOf": [

            
                          {

            
                            "$ref": "Field.json"

            
                          },

            
                          {

            
                            "$ref": "ImplementationDefined.json"

            
                          },

            
                          {

            
                            "$ref": "Reserved.json"

            
                          },

            
                          {

            
                            "$ref": "ReservedInternal.json"

            
                          },

            
                          {

            
                            "$ref": "Array.json"

            
                          },

            
                          {

            
                            "$ref": "Dynamic.json"

            
                          },

            
                          {

            
                            "$ref": "Vector.json"

            
                          },

            
                          {

            
                            "$ref": "ConstantField.json"

            
                          },

            
                          {

            
                            "type": "array",

            
                            "items": {

            
                              "oneOf": [

            
                                {

            
                                  "$ref": "Field.json"

            
                                },

            
                                {

            
                                  "$ref": "ImplementationDefined.json"

            
                                },

            
                                {

            
                                  "$ref": "Reserved.json"

            
                                },

            
                                {

            
                                  "$ref": "ReservedInternal.json"

            
                                },

            
                                {

            
                                  "$ref": "Dynamic.json"

            
                                },

            
                                {

            
                                  "$ref": "ConstantField.json"

            
                                }

            
                              ]

            
                            },

            
                            "minItems": 1

            
                          }

            
                        ]

            
                      }

            
                    },

            
                    "required": [

            
                      "condition",

            
                      "field"

            
                    ],

            
                    "type": "object"

            
                  },

            
                  "type": "array",

            
                  "examples": [

            
                    [

            
                      {

            
                        "condition": {

            
                          "_type": "AST.Function",

            
                          "arguments": [

            
                            {

            
                              "_type": "AST.Identifier",

            
                              "value": "MYFEATURE"

            
                            }

            
                          ],

            
                          "name": "IsFeatureImplemented"

            
                        },

            
                        "field": {

            
                          "_type": "Fields.Field",

            
                          "name": "F1",

            
                          "rangeset": [

            
                            {

            
                              "_type": "Range",

            
                              "start": 0,

            
                              "width": 2

            
                            }

            
                          ],

            
                          "description": {

            
                            "_type": "Description",

            
                            "after": null,

            
                            "before": "A field that exist when MYFEATURE is implemented"

            
                          },

            
                          "values": {

            
                            "_type": "Valuesets.Values",

            
                            "values": [

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "First value",

            
                                "value": "'00'"

            
                              },

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "Second value",

            
                                "value": "'10'"

            
                              }

            
                            ]

            
                          }

            
                        }

            
                      },

            
                      {

            
                        "condition": null,

            
                        "field": {

            
                          "_type": "Fields.Field",

            
                          "name": "F1",

            
                          "rangeset": [

            
                            {

            
                              "_type": "Range",

            
                              "start": 0,

            
                              "width": 2

            
                            }

            
                          ],

            
                          "description": {

            
                            "_type": "Description",

            
                            "after": null,

            
                            "before": [

            
                              [

            
                                "A field that exists when all previous conditions fail. ",

            
                                "In this case, this field exists when ",

            
                                "MYFEATURE is not implemented"

            
                              ]

            
                            ]

            
                          },

            
                          "values": {

            
                            "_type": "Valuesets.Values",

            
                            "values": [

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "First value",

            
                                "value": "'00'"

            
                              },

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "Second value",

            
                                "value": "'10'"

            
                              }

            
                            ]

            
                          }

            
                        }

            
                      }

            
                    ]

            
                  ]

            
                },

            
                "volatile": {

            
                  "see": "../Fields/Field.json",

            
                  "type": "boolean"

            
                },

            
                "name": {

            
                  "see": "../Fields/Field.json",

            
                  "type": [

            
                    "string",

            
                    "null"

            
                  ]

            
                },

            
                "rangeset": {

            
                  "see": "../Fields/Field.json",

            
                  "$ref": "../Rangeset.json"

            
                },

            
                "reservedtype": {

            
                  "info": [

            
                    [

            
                      "If no default conditional field is represented, then a Reserved field with the ",

            
                      "value of `reservedtype` is used to define the default case."

            
                    ]

            
                  ],

            
                  "$ref": "../Enums/ReservedTypes.json"

            
                },

            
                "resets": {

            
                  "see": "../Fields/Field.json",

            
                  "$ref": "../FieldResets.json"

            
                }

            
              },

            
              "required": [

            
                "name",

            
                "rangeset",

            
                "fields",

            
                "reservedtype"

            
              ],

            
              "title": "ConditionalField",

            
              "type": "object",

            
              "examples": [

            
                {

            
                  "_type": "Fields.ConditionalField",

            
                  "name": "FOO",

            
                  "rangeset": [

            
                    {

            
                      "_type": "Range",

            
                      "start": 10,

            
                      "width": 11

            
                    }

            
                  ],

            
                  "description": {

            
                    "_type": "Description",

            
                    "after": null,

            
                    "before": [

            
                      [

            
                        "A conditional field, where the field F1 (when MYFEATURE is implemented)",

            
                        "is located at 11:10 (absolute position), and bits 20:12 are RES0 due",

            
                        "to the reservedtype property."

            
                      ],

            
                      [

            
                        "When MYFEATURE is not implemented then bits 20:10 are RES0 which comes",

            
                        "from the reservedtype"

            
                      ]

            
                    ]

            
                  },

            
                  "fields": [

            
                    {

            
                      "condition": {

            
                        "_type": "AST.Function",

            
                        "arguments": [

            
                          {

            
                            "_type": "AST.Identifier",

            
                            "value": "MYFEATURE"

            
                          }

            
                        ],

            
                        "name": "IsFeatureImplemented"

            
                      },

            
                      "field": {

            
                        "_type": "Fields.Field",

            
                        "name": "F1",

            
                        "rangeset": [

            
                          {

            
                            "_type": "Range",

            
                            "start": 0,

            
                            "width": 2

            
                          }

            
                        ],

            
                        "description": {

            
                          "_type": "Description",

            
                          "after": null,

            
                          "before": "A field that exists when MYFEATURE is implemented"

            
                        },

            
                        "values": {

            
                          "_type": "Valuesets.Values",

            
                          "values": [

            
                            {

            
                              "_type": "Values.Value",

            
                              "meaning": "First value",

            
                              "value": "'00'"

            
                            },

            
                            {

            
                              "_type": "Values.Value",

            
                              "meaning": "Second value",

            
                              "value": "'10'"

            
                            }

            
                          ]

            
                        }

            
                      }

            
                    }

            
                  ],

            
                  "reservedtype": "RES0"

            
                },

            
                {

            
                  "_type": "Fields.ConditionalField",

            
                  "name": "BAR",

            
                  "rangeset": [

            
                    {

            
                      "_type": "Range",

            
                      "start": 20,

            
                      "width": 10

            
                    }

            
                  ],

            
                  "description": {

            
                    "_type": "Description",

            
                    "after": null,

            
                    "before": [

            
                      [

            
                        "A conditional field, which resolves to a list of fields.",

            
                        "The field F1's rangeset will change to 23:20 and the field F2's rangeset",

            
                        "will change to 29:26 after the conditional field is resolved.",

            
                        "The remaning rangeset of 25:24, will be filled with RES0."

            
                      ]

            
                    ]

            
                  },

            
                  "fields": [

            
                    {

            
                      "condition": {

            
                        "_type": "AST.Bool",

            
                        "value": true

            
                      },

            
                      "field": [

            
                        {

            
                          "_type": "Fields.Field",

            
                          "name": "F1",

            
                          "rangeset": [

            
                            {

            
                              "_type": "Range",

            
                              "start": 0,

            
                              "width": 4

            
                            }

            
                          ],

            
                          "description": {

            
                            "_type": "Description",

            
                            "after": null,

            
                            "before": "After resolving, this field's rangeset becomes 23:20"

            
                          },

            
                          "values": {

            
                            "_type": "Valuesets.Values",

            
                            "values": [

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "First value",

            
                                "value": "'00'"

            
                              },

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "Second value",

            
                                "value": "'10'"

            
                              }

            
                            ]

            
                          }

            
                        },

            
                        {

            
                          "_type": "Fields.Field",

            
                          "name": "F2",

            
                          "rangeset": [

            
                            {

            
                              "_type": "Range",

            
                              "start": 6,

            
                              "width": 4

            
                            }

            
                          ],

            
                          "description": {

            
                            "_type": "Description",

            
                            "after": null,

            
                            "before": "After resolving, this field's rangeset becomes 29:26"

            
                          },

            
                          "values": {

            
                            "_type": "Valuesets.Values",

            
                            "values": [

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "First value",

            
                                "value": "'00'"

            
                              },

            
                              {

            
                                "_type": "Values.Value",

            
                                "meaning": "Second value",

            
                                "value": "'10'"

            
                              }

            
                            ]

            
                          }

            
                        }

            
                      ]

            
                    }

            
                  ],

            
                  "reservedtype": "RES0"

            
                }

            
              ],

            
              "$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>
	<!-- 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>ConditionalField - 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">&nlarr; Home</div></a>
	</div>
	</div>

	<div class="container">



















	<div class="row">




	<h2>
	<span class="title-namespace">Fields.</span><span class=" title-type">ConditionalField</span>

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




	<div class="static-markdown"><p>The ConditionalField is used to specify a field which has different properties under different conditions.</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.ConditionalField</code>
	</dd>
	</dl>



	</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>Provides the description of this conditional field.</p></div>

	<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/fields" class="property">
	<th class="col-md-4">
	<a href="#/properties/fields">fields<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<div><span class="type">array</span> [</div>




	<div>]</div>
	</td>
	<td class="col-md-4">
	<div><p>A list of objects with a field and condition, where the ConditionalField can resolve to one of the fields. Each field is accompanied by a condition to indicate when this field applies.</p>
	<p>The objects are resolved sequentially, meaning the ConditionalField resolves to the first field with a condition that evaluates True. If all conditions are False then the default reserved_type property is used as a shorthand.</p>
	<p>If a condition is null, then that Field will be considered the default.</p>
	<p><strong>WARNING</strong>: Since conditions are resolved sequentially the default (null) condition should be last.</p>
	<p>Also note that the rangeset of the individual fields should be set relative
	the <code>ConditionalField</code> rangeset. For example, if the ConditionalField's
	<a href="../Rangeset_schema.html">Rangeset</a> is <code>30:25</code>, then all internal fields should
	have ranges <code>5:0</code>.</p>
	<p>Further note that a ConditionalField could resolve to a field or a list of fields (limited to all field types except Vectors and Arrays).</p>
	<p>This is primarily to allow an Array or Vector to be replaced by a the list of fields they create when expanded.</p></div>

	<h5>Examples</h5>
	<div>
	<pre class="schema-json"><code class="language-json">[
	{
	"condition": {
	"_type": "AST.Function",
	"arguments": [
	{
	"_type": "AST.Identifier",
	"value": "MYFEATURE"
	}
	],
	"name": "IsFeatureImplemented"
	},
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "A field that exist when MYFEATURE is implemented"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	},
	{
	"condition": null,
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A field that exists when all previous conditions fail. ",
	"In this case, this field exists when ",
	"MYFEATURE is not implemented"
	]
	]
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	}
	]</code></pre>
	</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>
	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>




	</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/reservedtype" class="property">
	<th class="col-md-4">
	<a href="#/properties/reservedtype">reservedtype<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</a>
	</td>
	<td class="col-md-4">
	<div><p>If no default conditional field is represented, then a Reserved field with the
	value of <code>reservedtype</code> is used to define the default case.</p></div>

	<div>
	See
	<a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</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/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">{
	"_type": "Fields.ConditionalField",
	"name": "FOO",
	"rangeset": [
	{
	"_type": "Range",
	"start": 10,
	"width": 11
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A conditional field, where the field F1 (when MYFEATURE is implemented)",
	"is located at 11:10 (absolute position), and bits 20:12 are RES0 due",
	"to the reservedtype property."
	],
	[
	"When MYFEATURE is not implemented then bits 20:10 are RES0 which comes",
	"from the reservedtype"
	]
	]
	},
	"fields": [
	{
	"condition": {
	"_type": "AST.Function",
	"arguments": [
	{
	"_type": "AST.Identifier",
	"value": "MYFEATURE"
	}
	],
	"name": "IsFeatureImplemented"
	},
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "A field that exists when MYFEATURE is implemented"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	}
	],
	"reservedtype": "RES0"
	}</code></pre>
	<pre class="schema-json"><code class="language-json">{
	"_type": "Fields.ConditionalField",
	"name": "BAR",
	"rangeset": [
	{
	"_type": "Range",
	"start": 20,
	"width": 10
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A conditional field, which resolves to a list of fields.",
	"The field F1's rangeset will change to 23:20 and the field F2's rangeset",
	"will change to 29:26 after the conditional field is resolved.",
	"The remaning rangeset of 25:24, will be filled with RES0."
	]
	]
	},
	"fields": [
	{
	"condition": {
	"_type": "AST.Bool",
	"value": true
	},
	"field": [
	{
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 4
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "After resolving, this field's rangeset becomes 23:20"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	},
	{
	"_type": "Fields.Field",
	"name": "F2",
	"rangeset": [
	{
	"_type": "Range",
	"start": 6,
	"width": 4
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "After resolving, this field's rangeset becomes 29:26"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	]
	}
	],
	"reservedtype": "RES0"
	}</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": [
	"The ConditionalField is used to specify a field which has different properties under different conditions."
	],
	"properties": {
	"_meta": {
	"$ref": "../Meta.json"
	},
	"_type": {
	"enum": [
	"Fields.ConditionalField"
	]
	},
	"description": {
	"info": [
	"Provides the description of this conditional field."
	],
	"$ref": "../Traits/HasDescription.json#/definitions/description",
	"see": "../Fields/Field.json"
	},
	"display": {
	"see": "../Fields/Field.json",
	"type": [
	"string",
	"null"
	]
	},
	"fields": {
	"additionalItems": false,
	"info": [
	"A list of objects with a field and condition, where the ConditionalField can resolve to one of the fields. Each field is accompanied by a condition to indicate when this field applies.",
	"The objects are resolved sequentially, meaning the ConditionalField resolves to the first field with a condition that evaluates True. If all conditions are False then the default reserved_type property is used as a shorthand.",
	"If a condition is null, then that Field will be considered the default.",
	"WARNING: Since conditions are resolved sequentially the default (null) condition should be last.",
	[
	"Also note that the rangeset of the individual fields should be set relative ",
	"the `ConditionalField` rangeset. For example, if the ConditionalField's ",
	"[Rangeset](../Rangeset_schema.html) is `30:25`, then all internal fields should ",
	"have ranges `5:0`."
	],
	"Further note that a ConditionalField could resolve to a field or a list of fields (limited to all field types except Vectors and Arrays).",
	"This is primarily to allow an Array or Vector to be replaced by a the list of fields they create when expanded."
	],
	"items": {
	"additionalProperties": false,
	"properties": {
	"condition": {
	"$ref": "../Traits/HasCondition.json#/definitions/condition"
	},
	"field": {
	"oneOf": [
	{
	"$ref": "Field.json"
	},
	{
	"$ref": "ImplementationDefined.json"
	},
	{
	"$ref": "Reserved.json"
	},
	{
	"$ref": "ReservedInternal.json"
	},
	{
	"$ref": "Array.json"
	},
	{
	"$ref": "Dynamic.json"
	},
	{
	"$ref": "Vector.json"
	},
	{
	"$ref": "ConstantField.json"
	},
	{
	"type": "array",
	"items": {
	"oneOf": [
	{
	"$ref": "Field.json"
	},
	{
	"$ref": "ImplementationDefined.json"
	},
	{
	"$ref": "Reserved.json"
	},
	{
	"$ref": "ReservedInternal.json"
	},
	{
	"$ref": "Dynamic.json"
	},
	{
	"$ref": "ConstantField.json"
	}
	]
	},
	"minItems": 1
	}
	]
	}
	},
	"required": [
	"condition",
	"field"
	],
	"type": "object"
	},
	"type": "array",
	"examples": [
	[
	{
	"condition": {
	"_type": "AST.Function",
	"arguments": [
	{
	"_type": "AST.Identifier",
	"value": "MYFEATURE"
	}
	],
	"name": "IsFeatureImplemented"
	},
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "A field that exist when MYFEATURE is implemented"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	},
	{
	"condition": null,
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A field that exists when all previous conditions fail. ",
	"In this case, this field exists when ",
	"MYFEATURE is not implemented"
	]
	]
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	}
	]
	]
	},
	"volatile": {
	"see": "../Fields/Field.json",
	"type": "boolean"
	},
	"name": {
	"see": "../Fields/Field.json",
	"type": [
	"string",
	"null"
	]
	},
	"rangeset": {
	"see": "../Fields/Field.json",
	"$ref": "../Rangeset.json"
	},
	"reservedtype": {
	"info": [
	[
	"If no default conditional field is represented, then a Reserved field with the ",
	"value of `reservedtype` is used to define the default case."
	]
	],
	"$ref": "../Enums/ReservedTypes.json"
	},
	"resets": {
	"see": "../Fields/Field.json",
	"$ref": "../FieldResets.json"
	}
	},
	"required": [
	"name",
	"rangeset",
	"fields",
	"reservedtype"
	],
	"title": "ConditionalField",
	"type": "object",
	"examples": [
	{
	"_type": "Fields.ConditionalField",
	"name": "FOO",
	"rangeset": [
	{
	"_type": "Range",
	"start": 10,
	"width": 11
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A conditional field, where the field F1 (when MYFEATURE is implemented)",
	"is located at 11:10 (absolute position), and bits 20:12 are RES0 due",
	"to the reservedtype property."
	],
	[
	"When MYFEATURE is not implemented then bits 20:10 are RES0 which comes",
	"from the reservedtype"
	]
	]
	},
	"fields": [
	{
	"condition": {
	"_type": "AST.Function",
	"arguments": [
	{
	"_type": "AST.Identifier",
	"value": "MYFEATURE"
	}
	],
	"name": "IsFeatureImplemented"
	},
	"field": {
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 2
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "A field that exists when MYFEATURE is implemented"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	}
	],
	"reservedtype": "RES0"
	},
	{
	"_type": "Fields.ConditionalField",
	"name": "BAR",
	"rangeset": [
	{
	"_type": "Range",
	"start": 20,
	"width": 10
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": [
	[
	"A conditional field, which resolves to a list of fields.",
	"The field F1's rangeset will change to 23:20 and the field F2's rangeset",
	"will change to 29:26 after the conditional field is resolved.",
	"The remaning rangeset of 25:24, will be filled with RES0."
	]
	]
	},
	"fields": [
	{
	"condition": {
	"_type": "AST.Bool",
	"value": true
	},
	"field": [
	{
	"_type": "Fields.Field",
	"name": "F1",
	"rangeset": [
	{
	"_type": "Range",
	"start": 0,
	"width": 4
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "After resolving, this field's rangeset becomes 23:20"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	},
	{
	"_type": "Fields.Field",
	"name": "F2",
	"rangeset": [
	{
	"_type": "Range",
	"start": 6,
	"width": 4
	}
	],
	"description": {
	"_type": "Description",
	"after": null,
	"before": "After resolving, this field's rangeset becomes 29:26"
	},
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"meaning": "First value",
	"value": "'00'"
	},
	{
	"_type": "Values.Value",
	"meaning": "Second value",
	"value": "'10'"
	}
	]
	}
	}
	]
	}
	],
	"reservedtype": "RES0"
	}
	],
	"$schema": "http://json-schema.org/draft-04/schema#",
	"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>