blob: 2b9383f57f65de574e39de64d32d92e192b5da34 [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>SquareOp - ARM Machine Readable Schema - 2.8</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.8</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">AST.</span><span class=" title-type">SquareOp</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>A model representing a bit slice of a value or a function call:</p>
<ul>
<li><code>VMID[]</code></li>
<li><code>NVMem[42]</code></li>
<li><code>REG0[31:16, 12]</code></li>
</ul></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>AST.SquareOp</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/arguments" class="property">
<th class="col-md-4">
<a href="#/properties/arguments">arguments</a>
</th>
<td class="col-md-4">
<div><span class="type">array</span> [</div>
<div class="items-oneOf">
<a href="BinaryOp_schema.html#/definitions/expression" class="schema_link">BinaryOp</a>
</div>
<div class="items-oneOf">
<a href="Slice_schema.html" class="schema_link">Slice</a>
</div>
<div>]</div>
</td>
<td class="col-md-4">
<div><p>The SquareOp's arguments.</p></div>
<div>
<b>Default</b>
<pre class="schema-json"><code class="language-json">[]</code></pre>
</div>
</td>
</tr>
<tr id="/properties/var" class="property">
<th class="col-md-4">
<a href="#/properties/var">var<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<a href="BinaryOp_schema.html#/definitions/expression" class="schema_link">BinaryOp</a>
</td>
<td class="col-md-4">
<div><p>The SquareOp name. Either a function name or an object to be sliced.</p></div>
<div>
See
<a href="BinaryOp_schema.html#/definitions/expression" class="schema_link">definitions.expression</a> in
<a href="BinaryOp_schema.html#/definitions/expression" class="schema_link">BinaryOp</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;AST.SquareOp&#34;,
&#34;var&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;VMID&#34;
},
&#34;arguments&#34;: []
}</code></pre>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;AST.SquareOp&#34;,
&#34;var&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;NVMem&#34;
},
&#34;arguments&#34;: [
{
&#34;_type&#34;: &#34;AST.Integer&#34;,
&#34;value&#34;: 42
}
]
}</code></pre>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;AST.SquareOp&#34;,
&#34;var&#34;: {
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;REG0&#34;
},
&#34;arguments&#34;: [
{
&#34;_type&#34;: &#34;AST.Slice&#34;,
&#34;left&#34;: {
&#34;_type&#34;: &#34;AST.Integer&#34;,
&#34;value&#34;: 31
},
&#34;right&#34;: {
&#34;_type&#34;: &#34;AST.Integer&#34;,
&#34;value&#34;: 16
}
},
{
&#34;_type&#34;: &#34;AST.Integer&#34;,
&#34;value&#34;: 12
}
]
}</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": false,
"examples": [
{
"_type": "AST.SquareOp",
"var": {
"_type": "AST.Identifier",
"value": "VMID"
},
"arguments": []
},
{
"_type": "AST.SquareOp",
"var": {
"_type": "AST.Identifier",
"value": "NVMem"
},
"arguments": [
{
"_type": "AST.Integer",
"value": 42
}
]
},
{
"_type": "AST.SquareOp",
"var": {
"_type": "AST.Identifier",
"value": "REG0"
},
"arguments": [
{
"_type": "AST.Slice",
"left": {
"_type": "AST.Integer",
"value": 31
},
"right": {
"_type": "AST.Integer",
"value": 16
}
},
{
"_type": "AST.Integer",
"value": 12
}
]
}
],
"info": [
"A model representing a bit slice of a value or a function call:",
[
" - `VMID[]`",
" - `NVMem[42]`",
" - `REG0[31:16, 12]`"
]
],
"properties": {
"_meta": {
"$ref": "../Meta.json"
},
"_type": {
"enum": [
"AST.SquareOp"
]
},
"var": {
"info": [
"The SquareOp name. Either a function name or an object to be sliced."
],
"$ref": "BinaryOp.json#/definitions/expression"
},
"arguments": {
"info": [
"The SquareOp's arguments."
],
"default": [],
"type": "array",
"items": {
"oneOf": [
{
"$ref": "BinaryOp.json#/definitions/expression"
},
{
"$ref": "Slice.json"
}
]
}
}
},
"required": [
"var"
],
"title": "SquareOp",
"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>