blob: a93dfd6f99520f821adf83bd14b9dcede6468d39 [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>ReservedInternal - 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">Fields.</span><span class=" title-type">ReservedInternal</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>A ReservedInternal field is a field that is reserved for future use, and converted later
into a Reserved field.</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.ReservedInternal</code>
</dd>
</dl>
</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/reserved_by" class="property">
<th class="col-md-4">
<a href="#/properties/reserved_by">reserved_by</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><p>The name of the person that has reserved this.</p></div>
</td>
</tr>
<tr id="/properties/reserved_for" class="property">
<th class="col-md-4">
<a href="#/properties/reserved_for">reserved_for</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><p>The profile or extension this field is reserved for.</p></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">
<a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</a>
</td>
<td class="col-md-4">
<div><p>A constant value for the the field representing the reserved type.</p></div>
<div>
See
<a href="../Enums/ReservedTypes_schema.html" class="schema_link">Enums.ReservedTypes</a>
for more information.
</div>
</td>
</tr>
<!-- patternProperties -->
<!-- object property attributes -->
<tr>
<td colspan="3">
<dl>
<dt>Additional Properties</dt>
<dd> 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.ReservedInternal&#34;,
&#34;rangeset&#34;: [
{
&#34;_type&#34;: &#34;Range&#34;,
&#34;start&#34;: 0,
&#34;width&#34;: 8
}
],
&#34;value&#34;: &#34;RES0&#34;,
&#34;reserved_by&#34;: &#34;James bond&#34;,
&#34;reserved_for&#34;: &#34;FEAT_007&#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">{
"additionalProperties": true,
"examples": [
{
"_type": "Fields.ReservedInternal",
"rangeset": [
{
"_type": "Range",
"start": 0,
"width": 8
}
],
"value": "RES0",
"reserved_by": "James bond",
"reserved_for": "FEAT_007"
}
],
"info": [
[
"A ReservedInternal field is a field that is reserved for future use, and converted later",
"into a Reserved field."
]
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"Fields.ReservedInternal"
]
},
"rangeset": {
"see": "../Fields/Field.json",
"$ref": "../Rangeset.json"
},
"reserved_by": {
"info": [
"The name of the person that has reserved this."
],
"type": [
"string",
"null"
]
},
"reserved_for": {
"info": [
"The profile or extension this field is reserved for."
],
"type": [
"string",
"null"
]
},
"value": {
"info": [
"A constant value for the the field representing the reserved type."
],
"$ref": "../Enums/ReservedTypes.json"
}
},
"required": [
"rangeset",
"value"
],
"title": "ReservedInternal",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#"
}</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>