Google Git
Sign in
kernel/pub/scm/linux/kernel/git/maz/AARCHMRS/HEAD/./docs/Values/Value_schema.html
blob: 9bb78953ca51fe7c9fabb8ff31b15a267300365e [file] [log] [blame]
<!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<!--FAVICON.ico-->
<meta name="msapplication-TileColor" content="#2b5797">
<meta name="msapplication-TileImage" content="../img/mstile-144x144.png">
<link rel="icon" href="../img/favicon.ico">
<title>Value - 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">Value</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>A value object defines a bitstring. A meaning can be optionally defined to
describe the context of this bitstring.</p></div>
</div>
<!-- definitions -->
<div class="row">
<h3><span class="type Xof">definition</span></h3>
<table class="table table-hover definitions">
<thead>
<tr>
<th class="col-md-4">Definitions</th>
<th class="col-md-4">Type</th>
<th class="col-md-4">Description</th>
</tr>
</thead>
<tbody>
<tr id="/definitions/value" class="property">
<th class="col-md-4">
<a href="#/definitions/value">value</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">
<dl>
<dt>Pattern</dt>
<dd><code title="Regex">/^(0(b[01x]+|x[0-9A-Fa-f]+)|&#39;[01x]+&#39;)$/</code></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</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>Values.Value</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><p>The meaning associated with this bitstring.</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 bitstring representing the value.</p>
<p>This must be a string of bits (each bit of which may take values <code>0</code>, <code>1</code> or <code>x</code>, this last indicating "could be either 0 or 1"), wrapped in single-quotes.</p></div>
<dl>
<dt>Pattern</dt>
<dd><code title="Regex">/^&#39;[01x]+&#39;$/</code></dd>
</dl>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">&#34;&#39;10&#39;&#34;</code></pre>
<pre class="schema-json"><code class="language-json">&#34;&#39;1x&#39;&#34;</code></pre>
</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.Value&#34;,
&#34;value&#34;: &#34;&#39;00001&#39;&#34;,
&#34;meaning&#34;: &#34;The first defined value&#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">{
"definitions": {
"value": {
"pattern": "^(0(b[01x]+|x[0-9A-Fa-f]+)|'[01x]+')$",
"type": "string"
}
},
"info": [
[
"A value object defines a bitstring. A meaning can be optionally defined to",
"describe the context of this bitstring."
]
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Values.Value"
]
},
"meaning": {
"$ref": "../Text.json",
"info": [
"The meaning associated with this bitstring."
]
},
"value": {
"info": [
"The bitstring representing the value.",
"This must be a string of bits (each bit of which may take values `0`, `1` or `x`, this last indicating \"could be either 0 or 1\"), wrapped in single-quotes."
],
"type": "string",
"pattern": "^'[01x]+'$",
"examples": [
"'10'",
"'1x'"
]
}
},
"required": [
"value"
],
"title": "Value",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"examples": [
{
"_type": "Values.Value",
"value": "'00001'",
"meaning": "The first defined value"
}
]
}</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>