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

295 lines
19 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: l4/vbus/vbus_interfaces.h File 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('vbus__interfaces_8h.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">vbus_interfaces.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>This header contains the definition of VBUS sub-interfaces and convenience functions to work with the interface IDs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>&gt;</code><br />
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for vbus_interfaces.h:</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="vbus__interfaces_8h__incl.svg" width="506" height="330"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="vbus__interfaces_8h__dep__incl.svg" width="770" height="110"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="vbus__interfaces_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:abe8a184dadfcfb78c997adb10f6251ba" id="r_abe8a184dadfcfb78c997adb10f6251ba"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe8a184dadfcfb78c997adb10f6251ba">l4vbus_iface_type_t</a></td></tr>
<tr class="memdesc:abe8a184dadfcfb78c997adb10f6251ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Different sub-interfaces a vbus device may support. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a23902b806a7e7e1ae8eef74d4d36b579" id="r_a23902b806a7e7e1ae8eef74d4d36b579"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a> { <br />
&#160;&#160;<a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579aa3da2ba11a6dd0cb3f57e036a4f8f7ef">L4VBUS_INTERFACE_ICU</a> = 0
, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579a731bf27bdaea87329c26d3c83d8f715c">L4VBUS_INTERFACE_GPIO</a>
, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579aae83b6663bc6c9d521fd1f02793ad500">L4VBUS_INTERFACE_PCI</a>
, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579ad5dec149109533fc792adb30b60c3e02">L4VBUS_INTERFACE_PCIDEV</a>
, <br />
&#160;&#160;<a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579ae177120699bd4cd27da277223579a59c">L4VBUS_INTERFACE_PM</a>
, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579a52a78da74c9d13b39823948c5d06ec26">L4VBUS_INTERFACE_BUS</a>
, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579a65308bf7aef09ef66bfa4dc875f92499">L4VBUS_INTERFACE_GENERIC</a> = 0x20
<br />
}</td></tr>
<tr class="memdesc:a23902b806a7e7e1ae8eef74d4d36b579"><td class="mdescLeft">&#160;</td><td class="mdescRight">Different sub-interfaces a vbus device may support. <a href="#a23902b806a7e7e1ae8eef74d4d36b579">More...</a><br /></td></tr>
<tr class="memitem:a38563611a20c95da60b51f02f94736ca" id="r_a38563611a20c95da60b51f02f94736ca"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="#a38563611a20c95da60b51f02f94736caa61d97f9760c17ec2d916fb9f060cad7b">L4VBUS_IFACE_SHIFT</a> = 26
}</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abf5784fb98744f795a882c6e61823475" id="r_abf5784fb98744f795a882c6e61823475"><td class="memItemLeft" align="right" valign="top"><a id="abf5784fb98744f795a882c6e61823475" name="abf5784fb98744f795a882c6e61823475"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>l4vbus_subinterface</b> (unsigned opcode)</td></tr>
<tr class="memdesc:abf5784fb98744f795a882c6e61823475"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the ID of the vbus sub-interface. <br /></td></tr>
<tr class="memitem:a64bdccce554bb2f5b803a8294364fc3e" id="r_a64bdccce554bb2f5b803a8294364fc3e"><td class="memItemLeft" align="right" valign="top"><a id="a64bdccce554bb2f5b803a8294364fc3e" name="a64bdccce554bb2f5b803a8294364fc3e"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>l4vbus_interface_opcode</b> (unsigned opcode)</td></tr>
<tr class="memdesc:a64bdccce554bb2f5b803a8294364fc3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the function opcode within the sub-interface of the vbus command. <br /></td></tr>
<tr class="memitem:a45a832648adfc666e788c74c07e779fe" id="r_a45a832648adfc666e788c74c07e779fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45a832648adfc666e788c74c07e779fe">l4vbus_subinterface_supported</a> (<a class="el" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a> dev_type, <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a> iface_type)</td></tr>
<tr class="memdesc:a45a832648adfc666e788c74c07e779fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a vbus device supports a given sub-interface. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This header contains the definition of VBUS sub-interfaces and convenience functions to work with the interface IDs. </p>
<p class="definition">Definition in file <a class="el" href="vbus__interfaces_8h_source.html">vbus_interfaces.h</a>.</p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
<a id="abe8a184dadfcfb78c997adb10f6251ba" name="abe8a184dadfcfb78c997adb10f6251ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe8a184dadfcfb78c997adb10f6251ba">&#9670;&#160;</a></span>l4vbus_iface_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a> <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Different sub-interfaces a vbus device may support. </p>
<p>The IPC interface of vbus devices is divided into functional groups of sub-interfaces. Every device must implement the generic interface which provides general device information. According to the type of device, additional functionality may be supported.</p>
<p>The sub-interface constants are first of all used to divide the function opcode space of the interface into these functional groups (see L4VBUS_IFACE_SHIFT). They also make up a bitmask that specify the type of the device, i.e. from the point of view of the client a device is defined by the kinds of sub-interfaces it supports. </p>
</div>
</div>
<a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
<a id="a38563611a20c95da60b51f02f94736ca" name="a38563611a20c95da60b51f02f94736ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38563611a20c95da60b51f02f94736ca">&#9670;&#160;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a38563611a20c95da60b51f02f94736caa61d97f9760c17ec2d916fb9f060cad7b" name="a38563611a20c95da60b51f02f94736caa61d97f9760c17ec2d916fb9f060cad7b"></a>L4VBUS_IFACE_SHIFT&#160;</td><td class="fielddoc"><p>Sub-interface ID shift. </p>
<p>Divides the function opcode sent via IPC into a sub-interface ID and the actual function opcode within the sub-interface. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="vbus__interfaces_8h_source.html#l00048">48</a> of file <a class="el" href="vbus__interfaces_8h_source.html">vbus_interfaces.h</a>.</p>
</div>
</div>
<a id="a23902b806a7e7e1ae8eef74d4d36b579" name="a23902b806a7e7e1ae8eef74d4d36b579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23902b806a7e7e1ae8eef74d4d36b579">&#9670;&#160;</a></span>l4vbus_iface_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Different sub-interfaces a vbus device may support. </p>
<p>The IPC interface of vbus devices is divided into functional groups of sub-interfaces. Every device must implement the generic interface which provides general device information. According to the type of device, additional functionality may be supported.</p>
<p>The sub-interface constants are first of all used to divide the function opcode space of the interface into these functional groups (see L4VBUS_IFACE_SHIFT). They also make up a bitmask that specify the type of the device, i.e. from the point of view of the client a device is defined by the kinds of sub-interfaces it supports. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579aa3da2ba11a6dd0cb3f57e036a4f8f7ef" name="a23902b806a7e7e1ae8eef74d4d36b579aa3da2ba11a6dd0cb3f57e036a4f8f7ef"></a>L4VBUS_INTERFACE_ICU&#160;</td><td class="fielddoc"><p>Interrupt Controller. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579a731bf27bdaea87329c26d3c83d8f715c" name="a23902b806a7e7e1ae8eef74d4d36b579a731bf27bdaea87329c26d3c83d8f715c"></a>L4VBUS_INTERFACE_GPIO&#160;</td><td class="fielddoc"><p>GPIO. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579aae83b6663bc6c9d521fd1f02793ad500" name="a23902b806a7e7e1ae8eef74d4d36b579aae83b6663bc6c9d521fd1f02793ad500"></a>L4VBUS_INTERFACE_PCI&#160;</td><td class="fielddoc"><p>PCI. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579ad5dec149109533fc792adb30b60c3e02" name="a23902b806a7e7e1ae8eef74d4d36b579ad5dec149109533fc792adb30b60c3e02"></a>L4VBUS_INTERFACE_PCIDEV&#160;</td><td class="fielddoc"><p>PCI Device. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579ae177120699bd4cd27da277223579a59c" name="a23902b806a7e7e1ae8eef74d4d36b579ae177120699bd4cd27da277223579a59c"></a>L4VBUS_INTERFACE_PM&#160;</td><td class="fielddoc"><p>Power Management. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579a52a78da74c9d13b39823948c5d06ec26" name="a23902b806a7e7e1ae8eef74d4d36b579a52a78da74c9d13b39823948c5d06ec26"></a>L4VBUS_INTERFACE_BUS&#160;</td><td class="fielddoc"><p>VBus. </p>
</td></tr>
<tr><td class="fieldname"><a id="a23902b806a7e7e1ae8eef74d4d36b579a65308bf7aef09ef66bfa4dc875f92499" name="a23902b806a7e7e1ae8eef74d4d36b579a65308bf7aef09ef66bfa4dc875f92499"></a>L4VBUS_INTERFACE_GENERIC&#160;</td><td class="fielddoc"><p>No specific sub interface. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="vbus__interfaces_8h_source.html#l00029">29</a> of file <a class="el" href="vbus__interfaces_8h_source.html">vbus_interfaces.h</a>.</p>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a45a832648adfc666e788c74c07e779fe" name="a45a832648adfc666e788c74c07e779fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a832648adfc666e788c74c07e779fe">&#9670;&#160;</a></span>l4vbus_subinterface_supported()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int l4vbus_subinterface_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a></td> <td class="paramname"><span class="paramname"><em>dev_type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a23902b806a7e7e1ae8eef74d4d36b579">l4vbus_iface_type_t</a></td> <td class="paramname"><span class="paramname"><em>iface_type</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a vbus device supports a given sub-interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_type</td><td>Device type as reported in <a class="el" href="structl4vbus__device__t.html" title="Detailed information about a vbus device.">l4vbus_device_t</a>. </td></tr>
<tr><td class="paramname">iface_type</td><td>Sub-interface type to check for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the device supports the sub-interface. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vbus__interfaces_8h_source.html#l00099">99</a> of file <a class="el" href="vbus__interfaces_8h_source.html">vbus_interfaces.h</a>.</p>
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00051">L4_INLINE</a>, and <a class="el" href="vbus__interfaces_8h_source.html#l00044">L4VBUS_INTERFACE_GENERIC</a>.</p>
</div>
</div>
</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"><b>l4</b></li><li class="navelem"><b>vbus</b></li><li class="navelem"><a href="vbus__interfaces_8h.html">vbus_interfaces.h</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>