Files
moslab-code/doc/source/html/l4re_servers_uvmm_uvmm_dtg.html
2025-09-12 15:55:45 +02:00

162 lines
7.2 KiB
HTML

<!-- HTML header for doxygen 1.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>L4Re Operating System Framework: uvmm_dtg The device tree generator for Uvmm</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="l4re-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">L4Re Operating System Framework
</div>
<div id="projectbrief">Interface and Usage Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('l4re_servers_uvmm_uvmm_dtg.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">uvmm_dtg The device tree generator for Uvmm </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_pkg_2uvmm_2doc_2uvmm__dtg"></a></p>
<p>A virtual machine in Uvmm is configured with a device tree that contains information about the VMs resources, memory layout, virtual CPUs and peripheral devices.</p>
<p>Uvmm_dtg is a tool to generate such a device tree at runtime according to its command line.</p>
<h1>Usage in <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a></h1>
<p>Example lua script for Ned: </p><pre class="fragment">-- Create DS holding device tree
local dt = L4.Env.user_factory:create(L4.Proto.Dataspace, 4 * 1024):m("rw");
-- Start the generator
L4.default_loader:start(
{
caps = { dt = dt },
}, "rom/uvmm_dtg dt"):wait();
-- Start uvmm
vmm.start_vm
{
...
ext_caps = { dt = dt },
fdt = "dt",
...
}
</pre><p>Please notice the <span class="tt">:wait()</span> when starting <span class="tt">uvmm_dtg</span>. This makes Ned pause until uvmm_dtg has exited and put the device tree into the dataspace such that Uvmm can commence.</p>
<h1>Usage</h1>
<p><span class="tt">uvmm_dtg [OPTION]... &lt;file&gt;|--</span></p>
<ul>
<li><span class="tt">--</span> print to stdout</li>
<li><p class="startli"><span class="tt">file</span></p>
<p class="startli">On <a class="el" href="namespaceL4Re.html" title="L4Re C++ Interfaces.">L4Re</a>, the string given as <span class="tt">&lt;file&gt;</span> is interpreted as a named capability which needs to be backed by a sufficiently large Dataspace. On Linux, a file with the given name is created. In both cases, uvmm_dtg will output into the named file.</p>
</li>
</ul>
<h2>Options</h2>
<ul>
<li><p class="startli"><span class="tt">-h</span></p>
<p class="startli">Show help.</p>
</li>
<li><p class="startli"><span class="tt">--arch &lt;target architecture&gt;</span></p>
<p class="startli">Select the target architecture. Valid options are <span class="tt">x86</span>, <span class="tt">x86_64</span>, <span class="tt">arm32</span>, <span class="tt">arm64</span>, <span class="tt">mips32</span> and <span class="tt">mips64</span>.</p>
</li>
<li><p class="startli"><span class="tt">--format &lt;format&gt;</span></p>
<p class="startli">Select the output format. Available formats are: <span class="tt">txt</span>: The device tree will be printed as plain text (<span class="tt">dts</span>). <span class="tt">bin</span>: The device tree will be output as binary (<span class="tt">dtb</span>).</p>
</li>
<li><p class="startli"><span class="tt">--mem-base &lt;membase&gt;</span></p>
<p class="startli">Configure the start of the memory distribution. <span class="tt">membase</span> can be defined in both decimal and hex notations. uvmm_dtg rounds the given base up to the platforms page size.</p>
<p class="startli">This value can be overridden by memory devices with fixed addresses.</p>
</li>
<li><p class="startli"><span class="tt">--device &lt;devicename:[Option1,Option2=value,Option3=value,...]&gt;</span></p>
<p class="startli">This configures a device.</p>
<p class="startli">To get a list of supported devices, use <span class="tt">--device help</span>.</p>
<p class="startli">To get help for a specific device, use <span class="tt">--device devicename:help</span>. </p>
</li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
</ul>
</div>
</body>
</html>