docs/Parameters/String_schema.html - pub/scm/linux/kernel/git/maz/AARCHMRS - Git at Google

 <!-- 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>Parameters.String - 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">Parameters.</span><span class=" title-type">String</span>

             <!-- if oneOf is set, then type is ignored -->
                 <span class="type">object</span>
         </h2>


     <div class="static-markdown"><p>String parameters are used to store a set of possible values.</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>Parameters.String</code>
                         </dd>
                     </dl>


             </td>
         </tr>

         <tr id="/properties/allow_empty" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/allow_empty">allow_empty</a>
             </th>
             <td class="col-md-4">
                         <ul class="inline list-type">
                                 <li class="inline type">boolean</li>
                         </ul>
             </td>
             <td class="col-md-4">
                     <div><p>When <code>true</code>, this parameter's domain can be empty.</p></div>
                     <div>
                         <b>Default</b>
                         <pre class="schema-json"><code class="language-json">false</code></pre>
                     </div>


             </td>
         </tr>

         <tr id="/properties/configured_by" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/configured_by">configured_by</a>
             </th>
             <td class="col-md-4">
                     <a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">definitions.configured_by</a> in
             <a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
         for more information.
     </div>


             </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="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">definitions.constraints</a> in
             <a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/description" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/description">description</a>
             </th>
             <td class="col-md-4">
                     <a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">definitions.description</a> in
             <a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/name" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/name">name<sup>&loz;</sup></a>
             </th>
             <td class="col-md-4">
                     <a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">definitions.name</a> in
             <a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/title" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/title">title</a>
             </th>
             <td class="col-md-4">
                     <a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
             </td>
             <td class="col-md-4">

     <div>
         See
             <a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">definitions.title</a> in
             <a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
         for more information.
     </div>


             </td>
         </tr>

         <tr id="/properties/values" class="property">
                 <th class="col-md-4">
                 <a href="#/properties/values">values<sup>&loz;</sup></a>
             </th>
             <td class="col-md-4">
                     <div><span class="type Xof">oneOf</span> [</div>


             <div class="items-oneOf">
                         array
             </div>
             <div class="items-oneOf">
                         string
             </div>


                     <div>]</div>
             </td>
             <td class="col-md-4">
                     <div><p>The current domain (possible values) of this <a class="schema_link" href="../Parameters/String_schema.html" title="Parameters.String">Parameters.String</a>.</p></div>

     <div>

     <!-- Can be one of following objects -->


         <div class="item-type">
                 <!-- type is an array -->
                     <span class="type"><span class="Xof">oneOf</span> array</span>


         </div>
         <div class="item-type">
                 <!-- type is a string -->
                     <span class="type"><span class="Xof">oneOf</span> string</span>


         </div>

     </div>


         <h5>Examples</h5>
         <div>
             <pre class="schema-json"><code class="language-json">&#34;DEFINED_VALUE&#34;</code></pre>
             <pre class="schema-json"><code class="language-json">&#34;ANOTHER DEFINED VALUE&#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>


         <h5>Examples</h5>
         <div>
             <pre class="schema-json"><code class="language-json">{
     &#34;_type&#34;: &#34;Parameters.String&#34;,
     &#34;name&#34;: &#34;STRING_PARAM&#34;,
     &#34;values&#34;: [
         &#34;SOME_VALUE&#34;,
         &#34;ANOTHER_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">{
   "additionalProperties": false,
   "examples": [
     {
       "_type": "Parameters.String",
       "name": "STRING_PARAM",
       "values": [
         "SOME_VALUE",
         "ANOTHER_VALUE"
       ]
     }
   ],
   "info": [
     "String parameters are used to store a set of possible values."
   ],
   "properties": {
     "_meta": {
       "$ref": "../Meta.json"
     },
     "_type": {
       "enum": [
         "Parameters.String"
       ]
     },
     "name": {
       "$ref": "ParameterAbstract.json#/definitions/name"
     },
     "title": {
       "$ref": "ParameterAbstract.json#/definitions/title"
     },
     "description": {
       "$ref": "ParameterAbstract.json#/definitions/description"
     },
     "constraints": {
       "$ref": "ParameterAbstract.json#/definitions/constraints"
     },
     "configured_by": {
       "$ref": "ParameterAbstract.json#/definitions/configured_by"
     },
     "values": {
       "info": [
         "The current domain (possible values) of this $(Parameters.String)."
       ],
       "oneOf": [
         {
           "type": "array",
           "items": {
             "type": "string"
           }
         },
         {
           "type": "string"
         }
       ],
       "examples": [
         "DEFINED_VALUE",
         "ANOTHER DEFINED VALUE"
       ]
     },
     "allow_empty": {
       "info": [
         "When `true`, this parameter's domain can be empty."
       ],
       "type": "boolean",
       "default": false
     }
   },
   "required": [
     "name",
     "values"
   ],
   "title": "Parameters.String",
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object"
 }</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>
	<!-- 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>Parameters.String - 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">Parameters.</span><span class=" title-type">String</span>

	<!-- if oneOf is set, then type is ignored -->
	<span class="type">object</span>
	</h2>




	<div class="static-markdown"><p>String parameters are used to store a set of possible values.</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>Parameters.String</code>
	</dd>
	</dl>



	</td>
	</tr>

	<tr id="/properties/allow_empty" class="property">
	<th class="col-md-4">
	<a href="#/properties/allow_empty">allow_empty</a>
	</th>
	<td class="col-md-4">
	<ul class="inline list-type">
	<li class="inline type">boolean</li>
	</ul>
	</td>
	<td class="col-md-4">
	<div><p>When <code>true</code>, this parameter's domain can be empty.</p></div>
	<div>
	<b>Default</b>
	<pre class="schema-json"><code class="language-json">false</code></pre>
	</div>



	</td>
	</tr>

	<tr id="/properties/configured_by" class="property">
	<th class="col-md-4">
	<a href="#/properties/configured_by">configured_by</a>
	</th>
	<td class="col-md-4">
	<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">definitions.configured_by</a> in
	<a href="ParameterAbstract_schema.html#/definitions/configured_by" class="schema_link">ParameterAbstract</a>
	for more information.
	</div>




	</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="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">definitions.constraints</a> in
	<a href="ParameterAbstract_schema.html#/definitions/constraints" class="schema_link">ParameterAbstract</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/description" class="property">
	<th class="col-md-4">
	<a href="#/properties/description">description</a>
	</th>
	<td class="col-md-4">
	<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">definitions.description</a> in
	<a href="ParameterAbstract_schema.html#/definitions/description" class="schema_link">ParameterAbstract</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/name" class="property">
	<th class="col-md-4">
	<a href="#/properties/name">name<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">definitions.name</a> in
	<a href="ParameterAbstract_schema.html#/definitions/name" class="schema_link">ParameterAbstract</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/title" class="property">
	<th class="col-md-4">
	<a href="#/properties/title">title</a>
	</th>
	<td class="col-md-4">
	<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
	</td>
	<td class="col-md-4">

	<div>
	See
	<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">definitions.title</a> in
	<a href="ParameterAbstract_schema.html#/definitions/title" class="schema_link">ParameterAbstract</a>
	for more information.
	</div>




	</td>
	</tr>

	<tr id="/properties/values" class="property">
	<th class="col-md-4">
	<a href="#/properties/values">values<sup>&loz;</sup></a>
	</th>
	<td class="col-md-4">
	<div><span class="type Xof">oneOf</span> [</div>




	<div class="items-oneOf">
	array
	</div>
	<div class="items-oneOf">
	string
	</div>


	<div>]</div>
	</td>
	<td class="col-md-4">
	<div><p>The current domain (possible values) of this <a class="schema_link" href="../Parameters/String_schema.html" title="Parameters.String">Parameters.String</a>.</p></div>

	<div>

	<!-- Can be one of following objects -->


	<div class="item-type">
	<!-- type is an array -->
	<span class="type"><span class="Xof">oneOf</span> array</span>





	</div>
	<div class="item-type">
	<!-- type is a string -->
	<span class="type"><span class="Xof">oneOf</span> string</span>







	</div>

	</div>


	<h5>Examples</h5>
	<div>
	<pre class="schema-json"><code class="language-json">"DEFINED_VALUE"</code></pre>
	<pre class="schema-json"><code class="language-json">"ANOTHER DEFINED VALUE"</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>


	<h5>Examples</h5>
	<div>
	<pre class="schema-json"><code class="language-json">{
	"_type": "Parameters.String",
	"name": "STRING_PARAM",
	"values": [
	"SOME_VALUE",
	"ANOTHER_VALUE"
	]
	}</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": "Parameters.String",
	"name": "STRING_PARAM",
	"values": [
	"SOME_VALUE",
	"ANOTHER_VALUE"
	]
	}
	],
	"info": [
	"String parameters are used to store a set of possible values."
	],
	"properties": {
	"_meta": {
	"$ref": "../Meta.json"
	},
	"_type": {
	"enum": [
	"Parameters.String"
	]
	},
	"name": {
	"$ref": "ParameterAbstract.json#/definitions/name"
	},
	"title": {
	"$ref": "ParameterAbstract.json#/definitions/title"
	},
	"description": {
	"$ref": "ParameterAbstract.json#/definitions/description"
	},
	"constraints": {
	"$ref": "ParameterAbstract.json#/definitions/constraints"
	},
	"configured_by": {
	"$ref": "ParameterAbstract.json#/definitions/configured_by"
	},
	"values": {
	"info": [
	"The current domain (possible values) of this $(Parameters.String)."
	],
	"oneOf": [
	{
	"type": "array",
	"items": {
	"type": "string"
	}
	},
	{
	"type": "string"
	}
	],
	"examples": [
	"DEFINED_VALUE",
	"ANOTHER DEFINED VALUE"
	]
	},
	"allow_empty": {
	"info": [
	"When `true`, this parameter's domain can be empty."
	],
	"type": "boolean",
	"default": false
	}
	},
	"required": [
	"name",
	"values"
	],
	"title": "Parameters.String",
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object"
	}</code></pre>
	</div>

	</div>

	<div class="container">
	<div class="footer text-right">
	Copyright © 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>