Google Git
Sign in
kernel / pub / scm / linux / kernel / git / maz / AARCHMRS / 20cae2914ca015edd61c53a91d3471bef8e6df16 / . / docs / Values / ImplementationDefined_schema.html
blob: 7106401c7aae308c83ebaa0643f879e9fff32497 [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>ImplementationDefined - ARM Machine Readable Schema - 2.7.1</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.1</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">ImplementationDefined</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>This value represents a single <code>ImplementationDefined</code> value.</p>
<p>If not all <code>ImplementationDefined</code> values are permitted, then the implemented value must be one of the values described in the constraints property.</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>Values.ImplementationDefined</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/constraints" class="property">
<th class="col-md-4">
<a href="#/properties/constraints">constraints</a>
</th>
<td class="col-md-4">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
<a href="../Valuesets/Values_schema.html" class="schema_link">Valuesets.Values</a>
</div>
<div class="items-oneOf">
null
</div>
<div>]</div>
</td>
<td class="col-md-4">
<div><p>This property highlights implementation constraints that apply.</p>
<p>When set to None no constraints apply.</p></div>
<div>
<!-- Can be one of following objects -->
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="../Valuesets/Values_schema.html">Valuesets.Values</a></span>
</div>
<div class="item-type">
<!-- type is a null -->
<span class="type"><span class="Xof">oneOf</span> null</span>
</div>
</div>
</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>
<!-- 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.ImplementationDefined&#34;,
&#34;meaning&#34;: &#34;An ImplementationDefined value with no constraints.&#34;
}</code></pre>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Values.ImplementationDefined&#34;,
&#34;meaning&#34;: &#34;An ImplementationDefined value with two constraints.&#34;,
&#34;constraints&#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;01&#39;&#34;,
&#34;meaning&#34;: &#34;Second 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">{
"info": [
"This value represents a single `ImplementationDefined` value.",
"If not all `ImplementationDefined` values are permitted, then the implemented value must be one of the values described in the constraints property."
],
"examples": [
{
"_type": "Values.ImplementationDefined",
"meaning": "An ImplementationDefined value with no constraints."
},
{
"_type": "Values.ImplementationDefined",
"meaning": "An ImplementationDefined value with two constraints.",
"constraints": {
"_type": "Valuesets.Values",
"values": [
{
"_type": "Values.Value",
"value": "'00'",
"meaning": "First Value"
},
{
"_type": "Values.Value",
"value": "'01'",
"meaning": "Second Value"
}
]
}
}
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Values.ImplementationDefined"
]
},
"meaning": {
"$ref": "../Text.json",
"see": "Value.json"
},
"constraints": {
"oneOf": [
{
"$ref": "../Valuesets/Values.json"
},
{
"type": "null"
}
],
"info": [
"This property highlights implementation constraints that apply.",
"When set to None no constraints apply."
]
}
},
"title": "ImplementationDefined",
"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>