790 lines
55 KiB
HTML
790 lines
55 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 functions</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('group__l4vbus__module.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">L4 Vbus functions </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>C interface of the Vbus API.
|
|
<a href="#details">More...</a></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 L4 Vbus functions:</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="group__l4vbus__module.svg" width="399" height="151"><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-groups" class="groupheader"><a id="groups" name="groups"></a>
|
|
Topics</h2></td></tr>
|
|
<tr class="memitem:l4vbus_5Fgpio_5Fmodule" id="r_l4vbus_5Fgpio_5Fmodule"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4vbus__gpio__module.html"><a class="el" href="namespaceL4vbus.html" title="C++ interface of the Vbus API.">L4vbus</a> GPIO functions </a></td></tr>
|
|
<tr class="memitem:l4vbus_5Fpci_5Fmodule" id="r_l4vbus_5Fpci_5Fmodule"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4vbus__pci__module.html"><a class="el" href="namespaceL4vbus.html" title="C++ interface of the Vbus API.">L4vbus</a> PCI functions </a></td></tr>
|
|
<tr class="memitem:l4vbus_5Fpm_5Fmodule" id="r_l4vbus_5Fpm_5Fmodule"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__l4vbus__pm__module.html"><a class="el" href="namespaceL4vbus.html" title="C++ interface of the Vbus API.">L4vbus</a> power management functions </a></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:gaaa3fba66d2a82d325d8882e52586b33b" id="r_gaaa3fba66d2a82d325d8882e52586b33b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaa3fba66d2a82d325d8882e52586b33b">L4vbus_dma_domain_assign_flags</a> { <a class="el" href="#ggaaa3fba66d2a82d325d8882e52586b33ba8548a664b9e6433322527f496d92df5c">L4VBUS_DMAD_UNBIND</a> = 0
|
|
, <a class="el" href="#ggaaa3fba66d2a82d325d8882e52586b33ba04cbfba164954838c2ae3d0fc06777b8">L4VBUS_DMAD_BIND</a> = 1
|
|
, <a class="el" href="#ggaaa3fba66d2a82d325d8882e52586b33ba2ca6d96e2f0b654536a8c680b2e1e008">L4VBUS_DMAD_L4RE_DMA_SPACE</a> = 0
|
|
, <a class="el" href="#ggaaa3fba66d2a82d325d8882e52586b33baf498313871474b775ace480b6ba1ae61">L4VBUS_DMAD_KERNEL_DMA_SPACE</a> = 2
|
|
}</td></tr>
|
|
<tr class="memdesc:gaaa3fba66d2a82d325d8882e52586b33b"><td class="mdescLeft"> </td><td class="mdescRight">Flags for <a class="el" href="#ga230bfade9c21a168c3863cbe4f39e01f" title="Bind or unbind a kernel DMA space or a L4Re::Dma_space to a DMA domain.">l4vbus_assign_dma_domain()</a>. <a href="#gaaa3fba66d2a82d325d8882e52586b33b">More...</a><br /></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:gaf965dbeed4864b72603c5ec69080f1ba" id="r_gaf965dbeed4864b72603c5ec69080f1ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf965dbeed4864b72603c5ec69080f1ba">l4vbus_get_device_by_hid</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> parent, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> *child, char const *hid, int depth, <a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo)</td></tr>
|
|
<tr class="memdesc:gaf965dbeed4864b72603c5ec69080f1ba"><td class="mdescLeft"> </td><td class="mdescRight">Find a device by the hardware interface identifier (HID). <br /></td></tr>
|
|
<tr class="memitem:ga1510914cb12bcd56b4caa65be360ee3c" id="r_ga1510914cb12bcd56b4caa65be360ee3c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1510914cb12bcd56b4caa65be360ee3c">l4vbus_get_next_device</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> parent, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> *child, int depth, <a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo)</td></tr>
|
|
<tr class="memdesc:ga1510914cb12bcd56b4caa65be360ee3c"><td class="mdescLeft"> </td><td class="mdescRight">Find next child following <span class="tt">child</span>. <br /></td></tr>
|
|
<tr class="memitem:ga51a6613ae6f11cc29269bf9623782e1d" id="r_ga51a6613ae6f11cc29269bf9623782e1d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga51a6613ae6f11cc29269bf9623782e1d">l4vbus_get_device</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev, <a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo)</td></tr>
|
|
<tr class="memdesc:ga51a6613ae6f11cc29269bf9623782e1d"><td class="mdescLeft"> </td><td class="mdescRight">Obtain detailed information about a Vbus device. <br /></td></tr>
|
|
<tr class="memitem:ga73c4138ed1d2d56edb5eabdbcc5da65d" id="r_ga73c4138ed1d2d56edb5eabdbcc5da65d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga73c4138ed1d2d56edb5eabdbcc5da65d">l4vbus_get_resource</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev, unsigned res_idx, <a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> *res)</td></tr>
|
|
<tr class="memdesc:ga73c4138ed1d2d56edb5eabdbcc5da65d"><td class="mdescLeft"> </td><td class="mdescRight">Obtain the resource description of an individual device resource. <br /></td></tr>
|
|
<tr class="memitem:gada51cecbba0d25a6d05e810b737f3df5" id="r_gada51cecbba0d25a6d05e810b737f3df5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gada51cecbba0d25a6d05e810b737f3df5">l4vbus_is_compatible</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev, char const *cid)</td></tr>
|
|
<tr class="memdesc:gada51cecbba0d25a6d05e810b737f3df5"><td class="mdescLeft"> </td><td class="mdescRight">Check if the given device has a compatibility ID (CID) or HID that matches <em class="arg">cid</em>. <br /></td></tr>
|
|
<tr class="memitem:ga49e5eea787382be584322a537f3e0bdd" id="r_ga49e5eea787382be584322a537f3e0bdd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga49e5eea787382be584322a537f3e0bdd">l4vbus_get_hid</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev, char *hid, unsigned long max_len)</td></tr>
|
|
<tr class="memdesc:ga49e5eea787382be584322a537f3e0bdd"><td class="mdescLeft"> </td><td class="mdescRight">Get the HID (hardware identifier) of a device. <br /></td></tr>
|
|
<tr class="memitem:ga2daf9887e40aed27c500e4fc01afc7c9" id="r_ga2daf9887e40aed27c500e4fc01afc7c9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2daf9887e40aed27c500e4fc01afc7c9">l4vbus_get_adr</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev, <a class="el" href="group__l4__basic__types.html#gac1d09f3e382e711b776931f10e6e1e5a">l4_uint32_t</a> *adr)</td></tr>
|
|
<tr class="memdesc:ga2daf9887e40aed27c500e4fc01afc7c9"><td class="mdescLeft"> </td><td class="mdescRight">Get the bus-specific address of a device. <br /></td></tr>
|
|
<tr class="memitem:ga7cafdd96c957a08f9e84b197ecfb956f" id="r_ga7cafdd96c957a08f9e84b197ecfb956f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7cafdd96c957a08f9e84b197ecfb956f">l4vbus_request_ioport</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *res)</td></tr>
|
|
<tr class="memdesc:ga7cafdd96c957a08f9e84b197ecfb956f"><td class="mdescLeft"> </td><td class="mdescRight">Request an IO port resource. <br /></td></tr>
|
|
<tr class="memitem:ga230bfade9c21a168c3863cbe4f39e01f" id="r_ga230bfade9c21a168c3863cbe4f39e01f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga230bfade9c21a168c3863cbe4f39e01f">l4vbus_assign_dma_domain</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, unsigned domain_id, unsigned flags, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> dma_space)</td></tr>
|
|
<tr class="memdesc:ga230bfade9c21a168c3863cbe4f39e01f"><td class="mdescLeft"> </td><td class="mdescRight">Bind or unbind a kernel <a class="el" href="group__l4__kernel__object__dmar__space.html">DMA space</a> or a <a class="el" href="classL4Re_1_1Dma__space.html" title="Managed DMA Address Space.">L4Re::Dma_space</a> to a DMA domain. <br /></td></tr>
|
|
<tr class="memitem:gaf6d8f34fe76d15c0e3e614c275be84dd" id="r_gaf6d8f34fe76d15c0e3e614c275be84dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf6d8f34fe76d15c0e3e614c275be84dd">l4vbus_release_ioport</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *res)</td></tr>
|
|
<tr class="memdesc:gaf6d8f34fe76d15c0e3e614c275be84dd"><td class="mdescLeft"> </td><td class="mdescRight">Release a previously requested IO port resource. <br /></td></tr>
|
|
<tr class="memitem:gaefeb0d86979de1ef1aa53951cc3764fd" id="r_gaefeb0d86979de1ef1aa53951cc3764fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaefeb0d86979de1ef1aa53951cc3764fd">l4vbus_vicu_get_cap</a> (<a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> vbus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> icu, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> cap)</td></tr>
|
|
<tr class="memdesc:gaefeb0d86979de1ef1aa53951cc3764fd"><td class="mdescLeft"> </td><td class="mdescRight">Get capability of ICU. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<p>C interface of the Vbus API. </p>
|
|
<p>The virtual bus (Vbus) is a hierarchical (tree) structure of device nodes where each device has a set of resources attached to it. Each virtual bus provides an Icu (<a class="el" href="group__l4__icu__api.html">Interrupt controller</a>) for interrupt handling.</p>
|
|
<p>The Vbus interface allows a client to find and query devices present on his virtual bus. After obtaining a device handle for a specific device the client can enumerate its resources.</p>
|
|
<dl class="section user"><dt>Include File</dt><dd><div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="vbus_8h.html">l4/vbus/vbus.h</a>></span> </div>
|
|
<div class="ttc" id="avbus_8h_html"><div class="ttname"><a href="vbus_8h.html">vbus.h</a></div><div class="ttdoc">Description of the vbus C API.</div></div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<p>Refer to <a class="el" href="namespaceL4vbus.html">L4vbus</a> for the C++ API. </p>
|
|
<a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gaaa3fba66d2a82d325d8882e52586b33b" name="gaaa3fba66d2a82d325d8882e52586b33b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaaa3fba66d2a82d325d8882e52586b33b">◆ </a></span>L4vbus_dma_domain_assign_flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#gaaa3fba66d2a82d325d8882e52586b33b">L4vbus_dma_domain_assign_flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Flags for <a class="el" href="#ga230bfade9c21a168c3863cbe4f39e01f" title="Bind or unbind a kernel DMA space or a L4Re::Dma_space to a DMA domain.">l4vbus_assign_dma_domain()</a>. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaaa3fba66d2a82d325d8882e52586b33ba8548a664b9e6433322527f496d92df5c" name="ggaaa3fba66d2a82d325d8882e52586b33ba8548a664b9e6433322527f496d92df5c"></a>L4VBUS_DMAD_UNBIND </td><td class="fielddoc"><p>Unbind the given DMA space from the DMA domain. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaaa3fba66d2a82d325d8882e52586b33ba04cbfba164954838c2ae3d0fc06777b8" name="ggaaa3fba66d2a82d325d8882e52586b33ba04cbfba164954838c2ae3d0fc06777b8"></a>L4VBUS_DMAD_BIND </td><td class="fielddoc"><p>Bind the given DMA space to the DMA domain. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaaa3fba66d2a82d325d8882e52586b33ba2ca6d96e2f0b654536a8c680b2e1e008" name="ggaaa3fba66d2a82d325d8882e52586b33ba2ca6d96e2f0b654536a8c680b2e1e008"></a>L4VBUS_DMAD_L4RE_DMA_SPACE </td><td class="fielddoc"><p>The given DMA space is an <a class="el" href="classL4Re_1_1Dma__space.html" title="Managed DMA Address Space.">L4Re::Dma_space</a>. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaaa3fba66d2a82d325d8882e52586b33baf498313871474b775ace480b6ba1ae61" name="ggaaa3fba66d2a82d325d8882e52586b33baf498313871474b775ace480b6ba1ae61"></a>L4VBUS_DMAD_KERNEL_DMA_SPACE </td><td class="fielddoc"><p>The given DMA space is a kernel DMA space (<a class="el" href="classL4_1_1Task.html" title="C++ interface of the Task kernel object, see Task for the C interface.">L4::Task</a>). </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus_8h_source.html#l00174">174</a> of file <a class="el" href="vbus_8h_source.html">vbus.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="ga230bfade9c21a168c3863cbe4f39e01f" name="ga230bfade9c21a168c3863cbe4f39e01f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga230bfade9c21a168c3863cbe4f39e01f">◆ </a></span>l4vbus_assign_dma_domain()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_assign_dma_domain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>domain_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>flags</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>dma_space</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bind or unbind a kernel <a class="el" href="group__l4__kernel__object__dmar__space.html">DMA space</a> or a <a class="el" href="classL4Re_1_1Dma__space.html" title="Managed DMA Address Space.">L4Re::Dma_space</a> to a DMA domain. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramname">domain_id</td><td>DMA domain ID (resource address of DMA domain found on the vBUS). If the value is ~0U the DMA space of the whole vBUS is used. </td></tr>
|
|
<tr><td class="paramname">flags</td><td>A combination of <a class="el" href="#gaaa3fba66d2a82d325d8882e52586b33b" title="Flags for l4vbus_assign_dma_domain().">L4vbus_dma_domain_assign_flags</a>. </td></tr>
|
|
<tr><td class="paramname">dma_space</td><td>The DMA space capability to bind or unbind, this must either be an <a class="el" href="classL4Re_1_1Dma__space.html" title="Managed DMA Address Space.">L4Re::Dma_space</a> or a kernel <a class="el" href="group__l4__kernel__object__dmar__space.html">DMA space</a> (<a class="el" href="classL4_1_1Task.html" title="C++ interface of the Task kernel object, see Task for the C interface.">L4::Task</a> created with L4_PROTO_DMA_SPACE) and the type must be reflected in the <span class="tt">flags</span>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Operation completed successfully. </td></tr>
|
|
<tr><td class="paramname">-L4_ENOENT</td><td>The vbus does not support a global DMA domain or no DMA domain could be found. </td></tr>
|
|
<tr><td class="paramname">-L4_EINVAL</td><td>Invalid argument used. </td></tr>
|
|
<tr><td class="paramname">-L4_EBUSY</td><td>DMA domain is already active, this means another DMA space is already assigned. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00382">L4vbus::Vbus::assign_dma_domain()</a>, and <a class="el" href="vbus_source.html#l00357">L4vbus::Vbus::assign_dma_domain()</a>.</p>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</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="group__l4vbus__module_ga230bfade9c21a168c3863cbe4f39e01f_icgraph.svg" width="424" height="115"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2daf9887e40aed27c500e4fc01afc7c9" name="ga2daf9887e40aed27c500e4fc01afc7c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2daf9887e40aed27c500e4fc01afc7c9">◆ </a></span>l4vbus_get_adr()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_get_adr </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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>adr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the bus-specific address of a device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">dev</td><td>Handle of the device </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">adr</td><td>Address</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">L4_EOK</td><td>Success. </td></tr>
|
|
<tr><td class="paramname">-L4_ENOSYS</td><td>Device has no valid address. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga51a6613ae6f11cc29269bf9623782e1d" name="ga51a6613ae6f11cc29269bf9623782e1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga51a6613ae6f11cc29269bf9623782e1d">◆ </a></span>l4vbus_get_device()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_get_device </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *</td> <td class="paramname"><span class="paramname"><em>devinfo</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Obtain detailed information about a Vbus device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the vbus to which the device is connected. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">dev</td><td>Device handle of the device from which to retrieve the details. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">devinfo</td><td>Information structure which contains details about the device. The pointer might be NULL.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname">-L4_ENODEV</td><td>No device with the given device handle <span class="tt">dev</span> could be found. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00189">L4vbus::Device::device()</a>.</p>
|
|
<div id="dynsection-2" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_ga51a6613ae6f11cc29269bf9623782e1d_icgraph.svg" width="374" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf965dbeed4864b72603c5ec69080f1ba" name="gaf965dbeed4864b72603c5ec69080f1ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf965dbeed4864b72603c5ec69080f1ba">◆ </a></span>l4vbus_get_device_by_hid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__l4sys__defines.html#ga5f022ce5422df9cc6ed415e2bfc90f59">L4_BEGIN_DECLS</a> int l4vbus_get_device_by_hid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>parent</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>hid</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *</td> <td class="paramname"><span class="paramname"><em>devinfo</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find a device by the hardware interface identifier (HID). </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramname">parent</td><td>Handle to the parent to start the search</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This function searches the vbus for a device with the given HID and returns a handle to the first matching device. The HID usually conforms to an ACPI HID or a Linux device tree compatible identifier.</p>
|
|
<p>It is possible to have multiple devices with the same HID on a vbus. In order to find all matching devices this function has to be called repeatedly with <span class="tt">child</span> pointing to the device found in the previous iteration. The iteration starts at <span class="tt">child</span> that might be any device node in the tree.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">child</td><td>Handle of the device from where in the device tree the search should start. To start searching from the beginning <span class="tt">child</span> must be initialized using the default (<a class="el" href="vbus_8h.html#a11792b1cd672d66434a0c76cfd53ca13a37b6c6ee1e53d4ddd172f43a8dedc9b0" title="NULL device.">L4VBUS_NULL</a>). If a matching device is found, its handle is returned through this parameter. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">hid</td><td>HID of the device </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">depth</td><td>Maximum depth for the recursive lookup </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">devinfo</td><td>Device information structure (might be NULL)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">>=0</td><td>A device with the given HID was found. </td></tr>
|
|
<tr><td class="paramname">-L4_ENOENT</td><td>No device with the given HID could be found on the vbus. </td></tr>
|
|
<tr><td class="paramname">-L4_EINVAL</td><td>Invalid or no HID provided. </td></tr>
|
|
<tr><td class="paramname">-L4_ENODEV</td><td>Function called on a non-existing device. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00148">L4vbus::Device::device_by_hid()</a>.</p>
|
|
<div id="dynsection-3" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_gaf965dbeed4864b72603c5ec69080f1ba_icgraph.svg" width="424" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga49e5eea787382be584322a537f3e0bdd" name="ga49e5eea787382be584322a537f3e0bdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga49e5eea787382be584322a537f3e0bdd">◆ </a></span>l4vbus_get_hid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_get_hid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>hid</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>max_len</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the HID (hardware identifier) of a device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramname">dev</td><td>Handle of the device </td></tr>
|
|
<tr><td class="paramname">hid</td><td>Pointer to a buffer for the HID string </td></tr>
|
|
<tr><td class="paramname">max_len</td><td>The size of the buffer (<em class="arg">hid</em>)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the length of the HID string on success, else failure </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1510914cb12bcd56b4caa65be360ee3c" name="ga1510914cb12bcd56b4caa65be360ee3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1510914cb12bcd56b4caa65be360ee3c">◆ </a></span>l4vbus_get_next_device()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_get_next_device </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>parent</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>child</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *</td> <td class="paramname"><span class="paramname"><em>devinfo</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find next child following <span class="tt">child</span>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">parent</td><td>Handle to the parent device (use <a class="el" href="vbus_8h.html#a11792b1cd672d66434a0c76cfd53ca13ad83203ea1310cc0d5be38f1df326acdd" title="Root device on the vbus.">L4VBUS_ROOT_BUS</a> for the system bus) </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">child</td><td>Handle of the device that precedes the device that shall be returned. To start from the beginning, <span class="tt">child</span> must be initialized with <a class="el" href="vbus_8h.html#a11792b1cd672d66434a0c76cfd53ca13a37b6c6ee1e53d4ddd172f43a8dedc9b0" title="NULL device.">L4VBUS_NULL</a>. If a device is found, its handle is returned through this parameter. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">depth</td><td>Depth to look for </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">devinfo</td><td>Device information (might be NULL)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, else failure </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00171">L4vbus::Device::next_device()</a>.</p>
|
|
<div id="dynsection-4" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_ga1510914cb12bcd56b4caa65be360ee3c_icgraph.svg" width="396" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga73c4138ed1d2d56edb5eabdbcc5da65d" name="ga73c4138ed1d2d56edb5eabdbcc5da65d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga73c4138ed1d2d56edb5eabdbcc5da65d">◆ </a></span>l4vbus_get_resource()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_get_resource </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>res_idx</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> *</td> <td class="paramname"><span class="paramname"><em>res</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Obtain the resource description of an individual device resource. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the vbus to which the device is connected. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">dev</td><td>Device handle of the device on the vbus. The device handle can be obtained by using the <a class="el" href="#gaf965dbeed4864b72603c5ec69080f1ba" title="Find a device by the hardware interface identifier (HID).">l4vbus_get_device_by_hid()</a> and <a class="el" href="#ga1510914cb12bcd56b4caa65be360ee3c" title="Find next child following child.">l4vbus_get_next_device()</a> functions. </td></tr>
|
|
<tr><td class="paramdir"></td><td class="paramname">res_idx</td><td>Index of the resource for which the resource description should be returned. The total number of resources for a device is available in the <a class="el" href="structl4vbus__device__t.html" title="Detailed information about a vbus device.">l4vbus_device_t</a> structure that is returned by <a class="el" href="classL4vbus_1_1Device.html#a555d6ec6b3e9b8d64fb8705f2cdf7cf7" title="Find a device by the hardware interface identifier (HID).">L4vbus::Device::device_by_hid()</a> and <a class="el" href="classL4vbus_1_1Device.html#ab8a12f148e84113f52856f29f086af50" title="Find next child following child.">L4vbus::Device::next_device()</a>. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">res</td><td>Descriptor of the resource.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This function returns the resource descriptor of an individual device resource selected by the <span class="tt">res_idx</span> parameter.</p>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname">-L4_ENOENT</td><td>Invalid resource index <span class="tt">res_idx</span>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00209">L4vbus::Device::get_resource()</a>.</p>
|
|
<div id="dynsection-5" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_ga73c4138ed1d2d56edb5eabdbcc5da65d_icgraph.svg" width="366" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gada51cecbba0d25a6d05e810b737f3df5" name="gada51cecbba0d25a6d05e810b737f3df5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gada51cecbba0d25a6d05e810b737f3df5">◆ </a></span>l4vbus_is_compatible()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_is_compatible </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>dev</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *</td> <td class="paramname"><span class="paramname"><em>cid</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if the given device has a compatibility ID (CID) or HID that matches <em class="arg">cid</em>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vbus</td><td>Capability of the system bus </td></tr>
|
|
<tr><td class="paramname">dev</td><td>device handle for which the CID shall be tested </td></tr>
|
|
<tr><td class="paramname">cid</td><td>the compatibility ID to test </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 when the given ID (<em class="arg">cid</em>) matches this device, 0 when the given ID does not match, <0 on error. </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00223">L4vbus::Device::is_compatible()</a>.</p>
|
|
<div id="dynsection-6" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_gada51cecbba0d25a6d05e810b737f3df5_icgraph.svg" width="362" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf6d8f34fe76d15c0e3e614c275be84dd" name="gaf6d8f34fe76d15c0e3e614c275be84dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf6d8f34fe76d15c0e3e614c275be84dd">◆ </a></span>l4vbus_release_ioport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_release_ioport </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *</td> <td class="paramname"><span class="paramname"><em>res</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Release a previously requested IO port resource. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the system bus. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">res</td><td>The IO port resource to be released from the bus.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>>=0 on success, <0 on error. </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="arm_2l4_2sys_2linkage_8h_source.html#l00033">L4_CV</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00323">L4vbus::Vbus::release_ioport()</a>.</p>
|
|
<div id="dynsection-7" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_gaf6d8f34fe76d15c0e3e614c275be84dd_icgraph.svg" width="388" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7cafdd96c957a08f9e84b197ecfb956f" name="ga7cafdd96c957a08f9e84b197ecfb956f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7cafdd96c957a08f9e84b197ecfb956f">◆ </a></span>l4vbus_request_ioport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_request_ioport </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> const *</td> <td class="paramname"><span class="paramname"><em>res</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Request an IO port resource. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">vbus</td><td>Capability of the system bus. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">res</td><td>The IO port resource to be requested from the bus.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">0</td><td>Success. </td></tr>
|
|
<tr><td class="paramname">-L4_EINVAL</td><td>Resource is not an IO port resource. </td></tr>
|
|
<tr><td class="paramname">-L4_ENOENT</td><td>No matching IO port resource found.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>If any IO port resource is found that contains the requested IO port range the IO ports are obtained. </p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00311">L4vbus::Vbus::request_ioport()</a>.</p>
|
|
<div id="dynsection-8" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_ga7cafdd96c957a08f9e84b197ecfb956f_icgraph.svg" width="391" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaefeb0d86979de1ef1aa53951cc3764fd" name="gaefeb0d86979de1ef1aa53951cc3764fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaefeb0d86979de1ef1aa53951cc3764fd">◆ </a></span>l4vbus_vicu_get_cap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int l4vbus_vicu_get_cap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>vbus</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a></td> <td class="paramname"><span class="paramname"><em>icu</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a></td> <td class="paramname"><span class="paramname"><em>cap</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get capability of ICU. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vbus</td><td>Capability of the system bus. </td></tr>
|
|
<tr><td class="paramname">icu</td><td>ICU device handle. </td></tr>
|
|
<tr><td class="paramname">cap</td><td>Capability slot for the capability.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, else failure </dd></dl>
|
|
|
|
<p class="reference">References <a class="el" href="compiler_8h_source.html#l00166">L4_END_DECLS</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus_source.html#l00285">L4vbus::Icu::vicu()</a>.</p>
|
|
<div id="dynsection-9" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Here is the caller graph for this function:</div>
|
|
<div id="dynsection-9-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-9-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4vbus__module_gaefeb0d86979de1ef1aa53951cc3764fd_icgraph.svg" width="347" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
|
|
</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="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>
|