docs/Values/Group_schema.html - pub/scm/linux/kernel/git/maz/AARCHMRS - Git at Google

 <!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
 <!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
 <!DOCTYPE html>
 <html>
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta http-equiv="x-ua-compatible" content="ie=edge">

     <!--FAVICON.ico-->
     <meta name="msapplication-TileColor" content="#2b5797">
     <meta name="msapplication-TileImage" content="../img/mstile-144x144.png">
     <link rel="icon" href="../img/favicon.ico">

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

     <div class="container">


 <div class="row">


         <h2>
                 <span class="title-namespace">Values.</span><span class=" title-type">Group</span>

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


     <div class="static-markdown"><p>A Group allows a value to be represented by the concatenation of different elements.</p>
 <p>For example, <code>0b00</code>, <code>'xx10'</code>, and <code>foo[2:0]</code> can be concatenated using the <code>:</code> symbol as <code>0b00:'xx10':foo[2:0]</code>.</p>
 <p>If <code>foo</code> is set to <code>12</code>
 then foo's binary representation is <code>'1100'</code> and the <code>[2:0]</code> slice of that is <code>'100'</code>.
 This makes the Group example <code>0b00:'xx10':foo[2:0]</code> represent the bitstring <code>'00xx10100'</code>.</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.Group</code>
                         </dd>
                     </dl>


             </td>
         </tr>

         <tr id="/properties/meaning" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/meaning">meaning<sup>&loz;</sup></a>
             </th>
             <td class="col-md-4">
                     <a href="../Text_schema.html" class="schema_link">Text</a>
             </td>
             <td class="col-md-4">
                     <div><p>The meaning of this group value.</p></div>

     <div>
         See
             <a href="../Text_schema.html" class="schema_link">Text</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>The string representation of the values property. </p>
 <p>It is invalid to write this differently to how <code>values</code> are represented.</p></div>

         <h5>Examples</h5>
         <div>
             <pre class="schema-json"><code class="language-json">&#34;&#39;00&#39;:foo[3:0]:&#39;x10&#39;&#34;</code></pre>
             <pre class="schema-json"><code class="language-json">&#34;foo[1:0]:&#39;xxxx10&#39;&#34;</code></pre>
         </div>


             </td>
         </tr>

         <tr id="/properties/values" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/values">values</a>
             </th>
             <td class="col-md-4">
                     <a href="../Valuesets/Values_schema.html" class="schema_link">Valuesets.Values</a>
             </td>
             <td class="col-md-4">
                     <div><p>Valueset with the resolved values for this variable.</p>
 <p>This data object can be used to elaborate the values in detail.</p></div>

     <div>
         See
             <a href="../Valuesets/Values_schema.html" class="schema_link">Valuesets.Values</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;Values.Group&#34;,
     &#34;value&#34;: &#34;&#39;00&#39;:&#39;xx10&#39;:foo[2:0]&#34;,
     &#34;meaning&#34;: &#34;Group meaning&#34;,
     &#34;values&#34;: {
         &#34;_type&#34;: &#34;Valuesets.Values&#34;,
         &#34;values&#34;: [
             {
                 &#34;_type&#34;: &#34;Values.Value&#34;,
                 &#34;value&#34;: &#34;&#39;00&#39;&#34;,
                 &#34;meaning&#34;: &#34;First Value&#34;
             },
             {
                 &#34;_type&#34;: &#34;Values.Value&#34;,
                 &#34;value&#34;: &#34;&#39;xx10&#39;&#34;,
                 &#34;meaning&#34;: &#34;First Value&#34;
             },
             {
                 &#34;_type&#34;: &#34;Values.EquationValue&#34;,
                 &#34;value&#34;: &#34;foo&#34;,
                 &#34;slice&#34;: [
                     {
                         &#34;_type&#34;: &#34;Range&#34;,
                         &#34;start&#34;: 0,
                         &#34;width&#34;: 3
                     }
                 ],
                 &#34;meaning&#34;: &#34;First three bits of the `foo` variable&#34;
             }
         ]
     }
 }</code></pre>
             <pre class="schema-json"><code class="language-json">{
     &#34;_type&#34;: &#34;Values.Group&#34;,
     &#34;value&#34;: &#34;foo[1:0]:&#39;xxxx10&#39;&#34;,
     &#34;meaning&#34;: &#34;Group meaning&#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": [
     "A Group allows a value to be represented by the concatenation of different elements.",
     "For example, `0b00`, `'xx10'`, and `foo[2:0]` can be concatenated using the `:` symbol as `0b00:'xx10':foo[2:0]`.",
     [
       "If `foo` is set to `12`",
       "then foo's binary representation is `'1100'` and the `[2:0]` slice of that is `'100'`.",
       "This makes the Group example `0b00:'xx10':foo[2:0]` represent the bitstring `'00xx10100'`."
     ]
   ],
   "examples": [
     {
       "_type": "Values.Group",
       "value": "'00':'xx10':foo[2:0]",
       "meaning": "Group meaning",
       "values": {
         "_type": "Valuesets.Values",
         "values": [
           {
             "_type": "Values.Value",
             "value": "'00'",
             "meaning": "First Value"
           },
           {
             "_type": "Values.Value",
             "value": "'xx10'",
             "meaning": "First Value"
           },
           {
             "_type": "Values.EquationValue",
             "value": "foo",
             "slice": [
               {
                 "_type": "Range",
                 "start": 0,
                 "width": 3
               }
             ],
             "meaning": "First three bits of the `foo` variable"
           }
         ]
       }
     },
     {
       "_type": "Values.Group",
       "value": "foo[1:0]:'xxxx10'",
       "meaning": "Group meaning"
     }
   ],
   "properties": {
     "_meta": {
       "$ref": "../Meta.json",
       "info": [
         "Metadata"
       ]
     },
     "_type": {
       "enum": [
         "Values.Group"
       ]
     },
     "meaning": {
       "$ref": "../Text.json",
       "info": [
         "The meaning of this group value."
       ]
     },
     "value": {
       "info": [
         "The string representation of the values property. ",
         "It is invalid to write this differently to how `values` are represented."
       ],
       "examples": [
         "'00':foo[3:0]:'x10'",
         "foo[1:0]:'xxxx10'"
       ],
       "type": "string"
     },
     "values": {
       "$ref": "../Valuesets/Values.json",
       "info": [
         "Valueset with the resolved values for this variable.",
         "This data object can be used to elaborate the values in detail."
       ]
     }
   },
   "required": [
     "value",
     "meaning"
   ],
   "title": "Group",
   "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>
	<!-- 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>Group - 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">&nlarr; Home</div></a>
	</div>
	</div>

	<div class="container">



















	<div class="row">




	<h2>
	<span class="title-namespace">Values.</span><span class=" title-type">Group</span>

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




	<div class="static-markdown"><p>A Group allows a value to be represented by the concatenation of different elements.</p>
	<p>For example, <code>0b00</code>, <code>'xx10'</code>, and <code>foo[2:0]</code> can be concatenated using the <code>:</code> symbol as <code>0b00:'xx10':foo[2:0]</code>.</p>
	<p>If <code>foo</code> is set to <code>12</code>
	then foo's binary representation is <code>'1100'</code> and the <code>[2:0]</code> slice of that is <code>'100'</code>.
	This makes the Group example <code>0b00:'xx10':foo[2:0]</code> represent the bitstring <code>'00xx10100'</code>.</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.Group</code>
	</dd>
	</dl>



	</td>
	</tr>

	<tr id="/properties/meaning" class="property">
	<th class="col-md-4">
	<a href="#/properties/meaning">meaning<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<a href="../Text_schema.html" class="schema_link">Text</a>
	</td>
	<td class="col-md-4">
	<div><p>The meaning of this group value.</p></div>

	<div>
	See
	<a href="../Text_schema.html" class="schema_link">Text</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>The string representation of the values property. </p>
	<p>It is invalid to write this differently to how <code>values</code> are represented.</p></div>

	<h5>Examples</h5>
	<div>
	<pre class="schema-json"><code class="language-json">"'00':foo[3:0]:'x10'"</code></pre>
	<pre class="schema-json"><code class="language-json">"foo[1:0]:'xxxx10'"</code></pre>
	</div>


	</td>
	</tr>

	<tr id="/properties/values" class="property">
	<th class="col-md-4">
	<a href="#/properties/values">values</a>
	</th>
	<td class="col-md-4">
	<a href="../Valuesets/Values_schema.html" class="schema_link">Valuesets.Values</a>
	</td>
	<td class="col-md-4">
	<div><p>Valueset with the resolved values for this variable.</p>
	<p>This data object can be used to elaborate the values in detail.</p></div>

	<div>
	See
	<a href="../Valuesets/Values_schema.html" class="schema_link">Valuesets.Values</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": "Values.Group",
	"value": "'00':'xx10':foo[2:0]",
	"meaning": "Group meaning",
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"value": "'00'",
	"meaning": "First Value"
	},
	{
	"_type": "Values.Value",
	"value": "'xx10'",
	"meaning": "First Value"
	},
	{
	"_type": "Values.EquationValue",
	"value": "foo",
	"slice": [
	{
	"_type": "Range",
	"start": 0,
	"width": 3
	}
	],
	"meaning": "First three bits of the `foo` variable"
	}
	]
	}
	}</code></pre>
	<pre class="schema-json"><code class="language-json">{
	"_type": "Values.Group",
	"value": "foo[1:0]:'xxxx10'",
	"meaning": "Group meaning"
	}</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 Group allows a value to be represented by the concatenation of different elements.",
	"For example, `0b00`, `'xx10'`, and `foo[2:0]` can be concatenated using the `:` symbol as `0b00:'xx10':foo[2:0]`.",
	[
	"If `foo` is set to `12`",
	"then foo's binary representation is `'1100'` and the `[2:0]` slice of that is `'100'`.",
	"This makes the Group example `0b00:'xx10':foo[2:0]` represent the bitstring `'00xx10100'`."
	]
	],
	"examples": [
	{
	"_type": "Values.Group",
	"value": "'00':'xx10':foo[2:0]",
	"meaning": "Group meaning",
	"values": {
	"_type": "Valuesets.Values",
	"values": [
	{
	"_type": "Values.Value",
	"value": "'00'",
	"meaning": "First Value"
	},
	{
	"_type": "Values.Value",
	"value": "'xx10'",
	"meaning": "First Value"
	},
	{
	"_type": "Values.EquationValue",
	"value": "foo",
	"slice": [
	{
	"_type": "Range",
	"start": 0,
	"width": 3
	}
	],
	"meaning": "First three bits of the `foo` variable"
	}
	]
	}
	},
	{
	"_type": "Values.Group",
	"value": "foo[1:0]:'xxxx10'",
	"meaning": "Group meaning"
	}
	],
	"properties": {
	"_meta": {
	"$ref": "../Meta.json",
	"info": [
	"Metadata"
	]
	},
	"_type": {
	"enum": [
	"Values.Group"
	]
	},
	"meaning": {
	"$ref": "../Text.json",
	"info": [
	"The meaning of this group value."
	]
	},
	"value": {
	"info": [
	"The string representation of the values property. ",
	"It is invalid to write this differently to how `values` are represented."
	],
	"examples": [
	"'00':foo[3:0]:'x10'",
	"foo[1:0]:'xxxx10'"
	],
	"type": "string"
	},
	"values": {
	"$ref": "../Valuesets/Values.json",
	"info": [
	"Valueset with the resolved values for this variable.",
	"This data object can be used to elaborate the values in detail."
	]
	}
	},
	"required": [
	"value",
	"meaning"
	],
	"title": "Group",
	"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 © 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>