Google Git
Sign in
kernel / pub / scm / linux / kernel / git / maz / AARCHMRS / 20cae2914ca015edd61c53a91d3471bef8e6df16 / . / docs / FieldResets_schema.html
blob: b69dc34576b31c4a02457d0441d956015c0e232c [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>FieldReset - 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-type">FieldResets</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>FieldReset holds the reset behavior that occurs in a specific domain.</p>
<ul>
<li><code>cold</code> and <code>warm</code> domains are reserved, where:<ul>
<li><code>cold</code>: A cold reset is invoked when a component is powered on from no power.</li>
<li><code>warm</code>: A warm reset is invoked when a component is told to reset while powered.</li>
</ul>
</li>
<li>Domains are case sensitive. So <code>cold</code> is not the same as <code>Cold</code>.</li>
<li>Users can keep building custom reset domains by defining new domain keys. </li>
<li>The domain should preferably be lower case only and not include any spaces, this is
allowed for legacy reasons, and support may end for this in the future.</li>
</ul></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/allowed_resets" class="property">
<th class="col-md-4">
<a href="#/definitions/allowed_resets">allowed_resets</a>
</th>
<td class="col-md-4">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
<a href="Resets/ImplementationDefined_schema.html" class="schema_link">Resets.ImplementationDefined</a>
</div>
<div class="items-oneOf">
<a href="Resets/Unknown_schema.html" class="schema_link">Resets.Unknown</a>
</div>
<div class="items-oneOf">
<a href="Resets/ConditionalReset_schema.html" class="schema_link">Resets.ConditionalReset</a>
</div>
<div class="items-oneOf">
<a href="Resets/ArchitecturallyUnknown_schema.html" class="schema_link">Resets.ArchitecturallyUnknown</a>
</div>
<div class="items-oneOf">
<a href="AST/BinaryOp_schema.html#/definitions/expression" class="schema_link">AST.BinaryOp</a>
</div>
<div>]</div>
</td>
<td class="col-md-4">
<div>
<!-- Can be one of following objects -->
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="Resets/ImplementationDefined_schema.html">Resets.ImplementationDefined</a></span>
</div>
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="Resets/Unknown_schema.html">Resets.Unknown</a></span>
</div>
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="Resets/ConditionalReset_schema.html">Resets.ConditionalReset</a></span>
</div>
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="Resets/ArchitecturallyUnknown_schema.html">Resets.ArchitecturallyUnknown</a></span>
</div>
<div class="item-type">
<span><span class="type Xof">oneOf</span> <a class="title-type" href="AST/BinaryOp_schema.html#/definitions/expression">AST.BinaryOp</a></span>
</div>
</div>
</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>FieldResets</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/domains" class="property">
<th class="col-md-4">
<a href="#/properties/domains">domains</a>
</th>
<td class="col-md-4">
<div>
<span class="type">object</span> {
<code title="Regex">/^[A-Za-z][A-Za-z0-9_]*$/</code> :
</div>
<div class="items-oneOf">
<div><span class="type Xof">oneOf</span> [</div>
<div class="items-oneOf">
<a href="#/definitions/allowed_resets" class="schema_link"></a>
</div>
<div class="items-oneOf">
<a href="Resets/InstanceReset_schema.html" class="schema_link">Resets.InstanceReset</a>
</div>
<div>]</div>
</div>
<div>}</div>
</td>
<td class="col-md-4">
<div><p>Define a list of reset per reset domain.</p>
<p>The most common cases are
<code>cold</code> and <code>warm</code>. However specific components can define custom
reset domains for example <code>debug</code>.</p></div>
</td>
</tr>
<tr id="/properties/text" class="property">
<th class="col-md-4">
<a href="#/properties/text">text</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>Descriptive information about the reset to help reader better understand the context of this reset.</p></div>
<div>
See
<a href="Text_schema.html" class="schema_link">Text</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;FieldResets&#34;,
&#34;domains&#34;: {
&#34;warm&#34;: {
&#34;_type&#34;: &#34;Resets.ArchitecturallyUnknown&#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": [
"FieldReset holds the reset behavior that occurs in a specific domain.",
[
" - `cold` and `warm` domains are reserved, where:",
" - `cold`: A cold reset is invoked when a component is powered on from no power.",
" - `warm`: A warm reset is invoked when a component is told to reset while powered.",
" - Domains are case sensitive. So `cold` is not the same as `Cold`.",
" - Users can keep building custom reset domains by defining new domain keys. ",
" - The domain should preferably be lower case only and not include any spaces, this is",
" allowed for legacy reasons, and support may end for this in the future."
]
],
"definitions": {
"allowed_resets": {
"oneOf": [
{
"$ref": "Resets/ImplementationDefined.json"
},
{
"$ref": "Resets/Unknown.json"
},
{
"$ref": "Resets/ConditionalReset.json"
},
{
"$ref": "Resets/ArchitecturallyUnknown.json"
},
{
"$ref": "AST/BinaryOp.json#/definitions/expression"
}
]
}
},
"examples": [
{
"_type": "FieldResets",
"domains": {
"warm": {
"_type": "Resets.ArchitecturallyUnknown"
}
}
}
],
"properties": {
"_meta": {
"$ref": "Meta.json"
},
"_type": {
"enum": [
"FieldResets"
]
},
"text": {
"$ref": "Text.json",
"info": [
"Descriptive information about the reset to help reader better understand the context of this reset."
]
},
"domains": {
"info": [
"Define a list of reset per reset domain.",
[
"The most common cases are",
"`cold` and `warm`. However specific components can define custom",
"reset domains for example `debug`."
]
],
"patternProperties": {
"^[A-Za-z][A-Za-z0-9_]*$": {
"oneOf": [
{
"$ref": "#/definitions/allowed_resets"
},
{
"$ref": "Resets/InstanceReset.json"
}
]
}
},
"type": "object"
}
},
"additionalProperties": false,
"title": "FieldReset",
"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>