docs/Values/EquationValue_schema.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>EquationValue - 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">Values.</span><span class=" title-type">EquationValue</span>

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


    

    <div class="static-markdown"><p>A EquationValue provides an infrastructure that defines a value
given an equation in the format <code>(&lt;value&gt;)[&lt;slice&gt;]</code>.</p>
<p>For example <code>((n * 2) + x)[3:0]</code>, where the values of <code>n</code> or <code>x</code> can
be defined by an implementation, and <code>[3:0]</code> provides an indication of the size
(4-bits) and slice (bits 3:0) of the value after evaluation.</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>Values.EquationValue</code>
                        </dd>
                    </dl>
                


            </td>
        </tr>
        
        <tr id="/properties/meaning" class="property">
                <th class="col-md-4">
                <a href="#/properties/meaning">meaning</a>
            </th>
            <td class="col-md-4">
                    <a href="../Text_schema.html" class="schema_link">Text</a>
            </td>
            <td class="col-md-4">
                        
    <div>
        See
            <a href="Value_schema.html#/properties/meaning" class="schema_link">properties.meaning</a> in
            <a href="Value_schema.html#/properties/meaning" class="schema_link">Value</a>
        for more information.
    </div>

                


            </td>
        </tr>
        
        <tr id="/properties/slice" class="property">
                <th class="col-md-4">
                <a href="#/properties/slice">slice<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><p>This represent the <code>[3:0]</code> part of the <code>EquationValue</code>.</p>
<p>The slice can start from any position (for example <code>[3:1]</code>) or be 
non-continuous (for example <code>[3:2, 0]</code>) and the evaluation of the value must
respect the slice.</p></div>
                    
    <div>
        See
            <a href="../Rangeset_schema.html" class="schema_link">Rangeset</a>
        for more information.
    </div>

                


            </td>
        </tr>
        
        <tr id="/properties/value" class="property">
                <th class="col-md-4">
                <a href="#/properties/value">value<sup>&loz;</sup></a>
            </th>
            <td class="col-md-4">
                        <ul class="inline list-type">
                                <li class="inline type">string</li>
                        </ul>
            </td>
            <td class="col-md-4">
                    <div><p>This represents the <code>(n * 2) + x</code> (note without leading parenthesis) part of
the <code>EquationValue</code>. The value stores the internal part of the equation.</p></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;Values.EquationValue&#34;, 
    &#34;meaning&#34;: &#34;Meaning EV&#34;, 
    &#34;value&#34;: &#34;((n * 2) - x)&#34;, 
    &#34;slice&#34;: [
        {
            &#34;_type&#34;: &#34;Range&#34;, 
            &#34;start&#34;: 0, 
            &#34;width&#34;: 4
        }
    ]
}</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": [
    [
      "A EquationValue provides an infrastructure that defines a value",
      "given an equation in the format `(<value>)[<slice>]`."
    ],
    [
      "For example `((n * 2) + x)[3:0]`, where the values of `n` or `x` can",
      "be defined by an implementation, and `[3:0]` provides an indication of the size",
      "(4-bits) and slice (bits 3:0) of the value after evaluation."
    ]
  ],
  "examples": [
    {
      "_type": "Values.EquationValue",
      "meaning": "Meaning EV",
      "value": "((n * 2) - x)",
      "slice": [
        {
          "_type": "Range",
          "start": 0,
          "width": 4
        }
      ]
    }
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json",
      "info": [
        "Metadata"
      ]
    },
    "_type": {
      "enum": [
        "Values.EquationValue"
      ]
    },
    "meaning": {
      "$ref": "../Text.json",
      "see": "Value.json"
    },
    "value": {
      "info": [
        [
          "This represents the `(n * 2) + x` (note without leading parenthesis) part of",
          "the `EquationValue`. The value stores the internal part of the equation."
        ]
      ],
      "type": "string"
    },
    "slice": {
      "info": [
        "This represent the `[3:0]` part of the `EquationValue`.",
        [
          "The slice can start from any position (for example `[3:1]`) or be ",
          "non-continuous (for example `[3:2, 0]`) and the evaluation of the value must",
          "respect the slice."
        ]
      ],
      "$ref": "../Rangeset.json"
    }
  },
  "required": [
    "value",
    "slice"
  ],
  "title": "EquationValue",
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "additionalProperties": false
}</code></pre>
</div>

    </div>

    <div class="container">
        <div class="footer text-right">
            Copyright &copy; 2025 ARM Limited or its affiliates. All rights reserved.
        </div>
    </div>

    <script src="../js/highlight/highlight.js"></script>
    <script src="../js/highlight/languages/json.min.js"></script>
    <script src="../js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
    <script src="../js/highlight/languages/yaml.min.js"></script>
    <script src="../js/highlight/languages/isa.js"></script>
    <script type="text/javascript">
        window.onload = function() {
            hljs.configure({
              cssSelector: ".schema-json code, .includes code, pre code",
              noHighlightRe: /^(no-?highlight|nohl)$/i,
            });
            hljs.highlightAll()
        };
    </script>

</body>
</html>