Google Git Google Git
Sign in
kernel/pub/scm/linux/kernel/git/maz/AARCHMRS/HEAD/./docs/Features_schema.html
blob: 115a2ef591411e71a059b2452a2aab08f78e1174 [file]
<!-- Copyright (c) 2010-2026 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>Features - ARM Machine Readable Schema - 2.9.6</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.9.6</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">Features</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>The <a class="schema_link" href="Features_schema.html" title="Features">Features</a> schema describes how to define dependencies in the architecture.
To understand how a <a class="schema_link" href="Features_schema.html" title="Features">Features</a> schema is used please see <a href="./userguide/features.html">the Features userguide</a>.</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>Features</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">
<a href="Traits/HasConstraints_schema.html#/definitions/constraints" class="schema_link">Traits.HasConstraints</a>
</td>
<td class="col-md-4">
<div><p>Globally defined constraints.</p></div>
<div>
See
<a href="Traits/HasConstraints_schema.html#/definitions/constraints" class="schema_link">definitions.constraints</a> in
<a href="Traits/HasConstraints_schema.html#/definitions/constraints" class="schema_link">Traits.HasConstraints</a>
for more information.
</div>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">[
{
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_A&#34;
},
&#34;op&#34;: &#34;==&gt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;v8Ap2&#34;
}
},
{
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_A&#34;
},
&#34;op&#34;: &#34;&lt;=&gt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;Types.Field&#34;,
&#34;value&#34;: {
&#34;state&#34;: &#34;AArch64&#34;,
&#34;name&#34;: &#34;IDREG&#34;,
&#34;field&#34;: &#34;A&#34;
}
},
&#34;op&#34;: &#34;==&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;value&#34;: &#34;&#39;0001&#39;&#34;
}
}
}
]</code></pre>
</div>
</td>
</tr>
<tr id="/properties/parameters" class="property">
<th class="col-md-4">
<a href="#/properties/parameters">parameters</a>
</th>
<td class="col-md-4">
<a href="Parameterset_schema.html" class="schema_link">Parameterset</a>
</td>
<td class="col-md-4">
<div><p>List of parameters used to facilitate Architecture configurability.</p></div>
<div>
See
<a href="Parameterset_schema.html" class="schema_link">Parameterset</a>
for more information.
</div>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">[
{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;v8Ap1&#34;
},
{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;v8Ap2&#34;
},
{
&#34;_type&#34;: &#34;Parameters.Boolean&#34;,
&#34;name&#34;: &#34;FEAT_A&#34;,
&#34;constraints&#34;: [
{
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_A&#34;
},
&#34;op&#34;: &#34;==&gt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;v8Ap2&#34;
}
},
{
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_A&#34;
},
&#34;op&#34;: &#34;&lt;=&gt;&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.BinaryOp&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;Types.Field&#34;,
&#34;value&#34;: {
&#34;state&#34;: &#34;AArch64&#34;,
&#34;name&#34;: &#34;IDREG&#34;,
&#34;field&#34;: &#34;A&#34;
}
},
&#34;op&#34;: &#34;==&#34;,
&#34;right&#34;: {
&#34;_type&#34;: &#34;Values.Value&#34;,
&#34;value&#34;: &#34;&#39;0001&#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>
</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">{
"$schema": "http://json-schema.org/draft-04/schema#",
"info": [
[
"The $(Features) schema describes how to define dependencies in the architecture.",
"To understand how a $(Features) schema is used please see [the Features userguide](./userguide/features.html)."
]
],
"properties": {
"_meta": {
"$ref": "Meta.json"
},
"_type": {
"enum": [
"Features"
]
},
"parameters": {
"info": [
"List of parameters used to facilitate Architecture configurability."
],
"$ref": "Parameterset.json",
"examples": [
[
{
"_type": "Parameters.Boolean",
"name": "v8Ap1"
},
{
"_type": "Parameters.Boolean",
"name": "v8Ap2"
},
{
"_type": "Parameters.Boolean",
"name": "FEAT_A",
"constraints": [
{
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "FEAT_A"
},
"op": "==>",
"right": {
"_type": "AST.Identifier",
"value": "v8Ap2"
}
},
{
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "FEAT_A"
},
"op": "<=>",
"right": {
"_type": "AST.BinaryOp",
"left": {
"_type": "Types.Field",
"value": {
"state": "AArch64",
"name": "IDREG",
"field": "A"
}
},
"op": "==",
"right": {
"_type": "Values.Value",
"value": "'0001'"
}
}
}
]
}
]
]
},
"constraints": {
"$ref": "Traits/HasConstraints.json#/definitions/constraints",
"info": [
"Globally defined constraints."
],
"examples": [
[
{
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "FEAT_A"
},
"op": "==>",
"right": {
"_type": "AST.Identifier",
"value": "v8Ap2"
}
},
{
"_type": "AST.BinaryOp",
"left": {
"_type": "AST.Identifier",
"value": "FEAT_A"
},
"op": "<=>",
"right": {
"_type": "AST.BinaryOp",
"left": {
"_type": "Types.Field",
"value": {
"state": "AArch64",
"name": "IDREG",
"field": "A"
}
},
"op": "==",
"right": {
"_type": "Values.Value",
"value": "'0001'"
}
}
}
]
]
}
},
"title": "Features",
"type": "object",
"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>