teaching/moslab-code
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

l4re-base-25.08.0

Browse Source
This commit is contained in:
Viktor Reusch
2025-09-12 15:55:45 +02:00
commit d959eaab98
37938 changed files with 9382688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

170
doc/source/html/structl4virtio__config__queue__t.html Normal file
View File

@@ -0,0 +1,170 @@
<!-- 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: l4virtio_config_queue_t Struct Reference</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('structl4virtio__config__queue__t.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 class="header">
<div class="headertitle"><div class="title">l4virtio_config_queue_t Struct Reference<div class="ingroups"><a class="el" href="group__l4virtio.html">L4 VIRTIO Interface</a> &raquo; <a class="el" href="group__l4virtio__transport.html">L4 VIRTIO Transport Layer</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Queue configuration entry.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="virtio_8h_source.html">virtio.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for l4virtio_config_queue_t:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="structl4virtio__config__queue__t__coll__graph.svg" width="176" height="216"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:adbd8746b07061f27508628fe442a594f" id="r_adbd8746b07061f27508628fe442a594f"><td class="memItemLeft" align="right" valign="top"><a id="adbd8746b07061f27508628fe442a594f" name="adbd8746b07061f27508628fe442a594f"></a>
<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>num_max</b></td></tr>
<tr class="memdesc:adbd8746b07061f27508628fe442a594f"><td class="mdescLeft">&#160;</td><td class="mdescRight">R: maximum number of descriptors supported by this queue. <br /></td></tr>
<tr class="memitem:af07ce7772cafbaab1d694e1e9d74f9be" id="r_af07ce7772cafbaab1d694e1e9d74f9be"><td class="memItemLeft" align="right" valign="top"><a id="af07ce7772cafbaab1d694e1e9d74f9be" name="af07ce7772cafbaab1d694e1e9d74f9be"></a>
<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>num</b></td></tr>
<tr class="memdesc:af07ce7772cafbaab1d694e1e9d74f9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">RW: number of descriptors configured for this queue. <br /></td></tr>
<tr class="memitem:ad533c96172ff34e3737aad54fba0282d" id="r_ad533c96172ff34e3737aad54fba0282d"><td class="memItemLeft" align="right" valign="top"><a id="ad533c96172ff34e3737aad54fba0282d" name="ad533c96172ff34e3737aad54fba0282d"></a>
<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ready</b></td></tr>
<tr class="memdesc:ad533c96172ff34e3737aad54fba0282d"><td class="mdescLeft">&#160;</td><td class="mdescRight">RW: queue ready flag (read-write). <br /></td></tr>
<tr class="memitem:a650490b621209f94d00cd9bb2c319066" id="r_a650490b621209f94d00cd9bb2c319066"><td class="memItemLeft" align="right" valign="top"><a id="a650490b621209f94d00cd9bb2c319066" name="a650490b621209f94d00cd9bb2c319066"></a>
<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>driver_notify_index</b></td></tr>
<tr class="memdesc:a650490b621209f94d00cd9bb2c319066"><td class="mdescLeft">&#160;</td><td class="mdescRight">W: Event index to be used for device notifications (device to driver). <br /></td></tr>
<tr class="memitem:a7c8175ec8a55273afc88e55e320fcbb1" id="r_a7c8175ec8a55273afc88e55e320fcbb1"><td class="memItemLeft" align="right" valign="top"><a id="a7c8175ec8a55273afc88e55e320fcbb1" name="a7c8175ec8a55273afc88e55e320fcbb1"></a>
<a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>desc_addr</b></td></tr>
<tr class="memdesc:a7c8175ec8a55273afc88e55e320fcbb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">W: address of descriptor table. <br /></td></tr>
<tr class="memitem:a6bb39fd7b5c6c5141a6e1c394dbfc17d" id="r_a6bb39fd7b5c6c5141a6e1c394dbfc17d"><td class="memItemLeft" align="right" valign="top"><a id="a6bb39fd7b5c6c5141a6e1c394dbfc17d" name="a6bb39fd7b5c6c5141a6e1c394dbfc17d"></a>
<a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>avail_addr</b></td></tr>
<tr class="memdesc:a6bb39fd7b5c6c5141a6e1c394dbfc17d"><td class="mdescLeft">&#160;</td><td class="mdescRight">W: address of available ring. <br /></td></tr>
<tr class="memitem:aaaa723731a983ca4bece81a7ef5703e9" id="r_aaaa723731a983ca4bece81a7ef5703e9"><td class="memItemLeft" align="right" valign="top"><a id="aaaa723731a983ca4bece81a7ef5703e9" name="aaaa723731a983ca4bece81a7ef5703e9"></a>
<a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>used_addr</b></td></tr>
<tr class="memdesc:aaaa723731a983ca4bece81a7ef5703e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">W: address of used ring. <br /></td></tr>
<tr class="memitem:a1e29c7fa324861eae395a204e52fa44a" id="r_a1e29c7fa324861eae395a204e52fa44a"><td class="memItemLeft" align="right" valign="top"><a id="a1e29c7fa324861eae395a204e52fa44a" name="a1e29c7fa324861eae395a204e52fa44a"></a>
<a class="el" href="group__l4__basic__types.html#gae8d67914f723bf843df6f311ad2619a2">l4_uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>device_notify_index</b></td></tr>
<tr class="memdesc:a1e29c7fa324861eae395a204e52fa44a"><td class="mdescLeft">&#160;</td><td class="mdescRight">R: Event index to be used by the driver (driver to device). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Queue configuration entry. </p>
<p>An array of such entries is available at the <a class="el" href="structl4virtio__config__hdr__t.html#a4da93c2cef05149a4fb6b4bd06a768d8" title="offset of virtqueue config array">l4virtio_config_hdr_t::queues_offset</a> in the config data space.</p>
<p>Consistency rules for the queue config are:</p><ul>
<li>A driver might read <span class="tt"><a class="el" href="#adbd8746b07061f27508628fe442a594f" title="R: maximum number of descriptors supported by this queue.">num_max</a></span> at any time.</li>
<li>A driver must write to <span class="tt"><a class="el" href="#af07ce7772cafbaab1d694e1e9d74f9be" title="RW: number of descriptors configured for this queue.">num</a></span>, <span class="tt"><a class="el" href="#a7c8175ec8a55273afc88e55e320fcbb1" title="W: address of descriptor table.">desc_addr</a></span>, <span class="tt"><a class="el" href="#a6bb39fd7b5c6c5141a6e1c394dbfc17d" title="W: address of available ring.">avail_addr</a></span>, and <span class="tt"><a class="el" href="#aaaa723731a983ca4bece81a7ef5703e9" title="W: address of used ring.">used_addr</a></span> only when <span class="tt"><a class="el" href="#ad533c96172ff34e3737aad54fba0282d" title="RW: queue ready flag (read-write).">ready</a></span> is zero (0). Values in these fields are validated and used by the device only after successfully setting <span class="tt"><a class="el" href="#ad533c96172ff34e3737aad54fba0282d" title="RW: queue ready flag (read-write).">ready</a></span> to one (1), either by the IPC or by L4VIRTIO_CMD_CFG_QUEUE.</li>
<li>The value of <span class="tt"><a class="el" href="#a1e29c7fa324861eae395a204e52fa44a" title="R: Event index to be used by the driver (driver to device).">device_notify_index</a></span> is valid only when <span class="tt"><a class="el" href="#ad533c96172ff34e3737aad54fba0282d" title="RW: queue ready flag (read-write).">ready</a></span> is one.</li>
<li>The driver might write to <span class="tt"><a class="el" href="#a1e29c7fa324861eae395a204e52fa44a" title="R: Event index to be used by the driver (driver to device).">device_notify_index</a></span> at any time, however the change is guaranteed to take effect after a successful L4VIRTIO_CMD_CFG_QUEUE or after a config_queue IPC. Note, the change might also have immediate effect, depending on the device implementation. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="virtio_8h_source.html#l00223">223</a> of file <a class="el" href="virtio_8h_source.html">virtio.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>l4/l4virtio/<a class="el" href="virtio_8h_source.html">virtio.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</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="navelem"><a href="structl4virtio__config__queue__t.html">l4virtio_config_queue_t</a></li>
<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>