461 lines
37 KiB
HTML
461 lines
37 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: L4vbus::Gpio_module Class 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('classL4vbus_1_1Gpio__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">L4vbus::Gpio_module Class Reference<div class="ingroups"><a class="el" href="group__api__l4re.html">L4Re C++ Interface</a> » <a class="el" href="group__api__l4re__vbus.html">Vbus API</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A <a class="el" href="classL4vbus_1_1Gpio__module.html" title="A Gpio_module groups multiple GPIO pins together.">Gpio_module</a> groups multiple GPIO pins together.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="vbus__gpio_source.html">vbus_gpio</a>></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>Inheritance diagram for L4vbus::Gpio_module:</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="classL4vbus_1_1Gpio__module__inherit__graph.svg" width="178" height="782"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<div id="dynsection-1" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4vbus::Gpio_module:</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="classL4vbus_1_1Gpio__module__coll__graph.svg" width="495" height="1418"><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-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:Pin_5Fslice" id="r_Pin_5Fslice"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A slice of the pins provided by this module. <a href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a05cbf73e4df7cc4fd4f32b2a47513bcf" id="r_a05cbf73e4df7cc4fd4f32b2a47513bcf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a05cbf73e4df7cc4fd4f32b2a47513bcf">setup</a> (<a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &mask, unsigned mode, unsigned value) const</td></tr>
|
|
<tr class="memdesc:a05cbf73e4df7cc4fd4f32b2a47513bcf"><td class="mdescLeft"> </td><td class="mdescRight">Configure function of multiple GPIO pins at once. <br /></td></tr>
|
|
<tr class="memitem:a353f5c9e3e0c77b57308c0f2b21de582" id="r_a353f5c9e3e0c77b57308c0f2b21de582"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a353f5c9e3e0c77b57308c0f2b21de582">config_pad</a> (<a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &mask, unsigned func, unsigned value) const</td></tr>
|
|
<tr class="memdesc:a353f5c9e3e0c77b57308c0f2b21de582"><td class="mdescLeft"> </td><td class="mdescRight">Hardware specific configuration function for multiple GPIO pins. <br /></td></tr>
|
|
<tr class="memitem:a6a0d6e8e9f1c8e1e97a02770be4000a2" id="r_a6a0d6e8e9f1c8e1e97a02770be4000a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6a0d6e8e9f1c8e1e97a02770be4000a2">get</a> (unsigned offset, unsigned *data) const</td></tr>
|
|
<tr class="memdesc:a6a0d6e8e9f1c8e1e97a02770be4000a2"><td class="mdescLeft"> </td><td class="mdescRight">Read values of multiple GPIO pins at once. <br /></td></tr>
|
|
<tr class="memitem:a8fc5645d80413e489f1f77da27f7c8c6" id="r_a8fc5645d80413e489f1f77da27f7c8c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8fc5645d80413e489f1f77da27f7c8c6">set</a> (<a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &mask, unsigned data)</td></tr>
|
|
<tr class="memdesc:a8fc5645d80413e489f1f77da27f7c8c6"><td class="mdescLeft"> </td><td class="mdescRight">Set multiple GPIO output pins at once. <br /></td></tr>
|
|
<tr class="memitem:aa55ec464dec7cf14fd6edb7b3e1bc7eb" id="r_aa55ec464dec7cf14fd6edb7b3e1bc7eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4vbus_1_1Gpio__pin.html">Gpio_pin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa55ec464dec7cf14fd6edb7b3e1bc7eb">pin</a> (unsigned pin) const</td></tr>
|
|
<tr class="memdesc:aa55ec464dec7cf14fd6edb7b3e1bc7eb"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classL4vbus_1_1Gpio__pin.html" title="A GPIO pin.">Gpio_pin</a> for a specific pin of this <a class="el" href="classL4vbus_1_1Gpio__module.html" title="A Gpio_module groups multiple GPIO pins together.">Gpio_module</a>. <br /></td></tr>
|
|
<tr class="inherit_header pub_methods_classL4vbus_1_1Device"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classL4vbus_1_1Device')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classL4vbus_1_1Device.html">L4vbus::Device</a></td></tr>
|
|
<tr class="memitem:a487d5e145d3a21935b61cc231cd84cec inherit pub_methods_classL4vbus_1_1Device" id="r_a487d5e145d3a21935b61cc231cd84cec"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>Device</b> ()</td></tr>
|
|
<tr class="memdesc:a487d5e145d3a21935b61cc231cd84cec inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new vbus device using the NULL device <a class="el" href="vbus_8h.html#a11792b1cd672d66434a0c76cfd53ca13a37b6c6ee1e53d4ddd172f43a8dedc9b0" title="NULL device.">L4VBUS_NULL</a>. <br /></td></tr>
|
|
<tr class="memitem:a3c2cb35016636efb93ca552c1c4b6b96 inherit pub_methods_classL4vbus_1_1Device" id="r_a3c2cb35016636efb93ca552c1c4b6b96"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a3c2cb35016636efb93ca552c1c4b6b96">Device</a> (<a class="el" href="classL4_1_1Cap.html">L4::Cap</a>< <a class="el" href="classL4vbus_1_1Vbus.html">Vbus</a> > bus, <a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> dev)</td></tr>
|
|
<tr class="memdesc:a3c2cb35016636efb93ca552c1c4b6b96 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new vbus device using a device handle. <br /></td></tr>
|
|
<tr class="memitem:a286c71ba7f0ab66fd9d90a9e91dfa560 inherit pub_methods_classL4vbus_1_1Device" id="r_a286c71ba7f0ab66fd9d90a9e91dfa560"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classL4_1_1Cap.html">L4::Cap</a>< <a class="el" href="classL4vbus_1_1Vbus.html">Vbus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a286c71ba7f0ab66fd9d90a9e91dfa560">bus_cap</a> () const</td></tr>
|
|
<tr class="memdesc:a286c71ba7f0ab66fd9d90a9e91dfa560 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Access the <a class="el" href="classL4vbus_1_1Vbus.html" title="The virtual bus (Vbus) interface.">Vbus</a> capability of the underlying virtual bus. <br /></td></tr>
|
|
<tr class="memitem:a63dcb7dba875e85f09f7ab755836bf2e inherit pub_methods_classL4vbus_1_1Device" id="r_a63dcb7dba875e85f09f7ab755836bf2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a63dcb7dba875e85f09f7ab755836bf2e">dev_handle</a> () const</td></tr>
|
|
<tr class="memdesc:a63dcb7dba875e85f09f7ab755836bf2e inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Access the device handle of this device. <br /></td></tr>
|
|
<tr class="memitem:a555d6ec6b3e9b8d64fb8705f2cdf7cf7 inherit pub_methods_classL4vbus_1_1Device" id="r_a555d6ec6b3e9b8d64fb8705f2cdf7cf7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a555d6ec6b3e9b8d64fb8705f2cdf7cf7">device_by_hid</a> (<a class="el" href="classL4vbus_1_1Device.html">Device</a> *child, char const *hid, int depth=L4VBUS_MAX_DEPTH, <a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo=0) const</td></tr>
|
|
<tr class="memdesc:a555d6ec6b3e9b8d64fb8705f2cdf7cf7 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Find a device by the hardware interface identifier (HID). <br /></td></tr>
|
|
<tr class="memitem:ab8a12f148e84113f52856f29f086af50 inherit pub_methods_classL4vbus_1_1Device" id="r_ab8a12f148e84113f52856f29f086af50"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#ab8a12f148e84113f52856f29f086af50">next_device</a> (<a class="el" href="classL4vbus_1_1Device.html">Device</a> *child, int depth=L4VBUS_MAX_DEPTH, <a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo=0) const</td></tr>
|
|
<tr class="memdesc:ab8a12f148e84113f52856f29f086af50 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Find next child following <span class="tt">child</span>. <br /></td></tr>
|
|
<tr class="memitem:a0bf2b1fdc767393f48f787c51ca20548 inherit pub_methods_classL4vbus_1_1Device" id="r_a0bf2b1fdc767393f48f787c51ca20548"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a0bf2b1fdc767393f48f787c51ca20548">device</a> (<a class="el" href="structl4vbus__device__t.html">l4vbus_device_t</a> *devinfo) const</td></tr>
|
|
<tr class="memdesc:a0bf2b1fdc767393f48f787c51ca20548 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Obtain detailed information about a <a class="el" href="classL4vbus_1_1Vbus.html" title="The virtual bus (Vbus) interface.">Vbus</a> device. <br /></td></tr>
|
|
<tr class="memitem:a2c8e285f3430e70174615374da658589 inherit pub_methods_classL4vbus_1_1Device" id="r_a2c8e285f3430e70174615374da658589"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a2c8e285f3430e70174615374da658589">get_resource</a> (unsigned res_idx, <a class="el" href="structl4vbus__resource__t.html">l4vbus_resource_t</a> *res) const</td></tr>
|
|
<tr class="memdesc:a2c8e285f3430e70174615374da658589 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Obtain the resource description of an individual device resource. <br /></td></tr>
|
|
<tr class="memitem:adb0724a360f168a71dba34e640c124f8 inherit pub_methods_classL4vbus_1_1Device" id="r_adb0724a360f168a71dba34e640c124f8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#adb0724a360f168a71dba34e640c124f8">is_compatible</a> (char const *cid) const</td></tr>
|
|
<tr class="memdesc:adb0724a360f168a71dba34e640c124f8 inherit pub_methods_classL4vbus_1_1Device"><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:a64fd18112b94f67568dfd48afda5db22 inherit pub_methods_classL4vbus_1_1Device" id="r_a64fd18112b94f67568dfd48afda5db22"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a64fd18112b94f67568dfd48afda5db22">operator==</a> (<a class="el" href="classL4vbus_1_1Device.html">Device</a> const &o) const</td></tr>
|
|
<tr class="memdesc:a64fd18112b94f67568dfd48afda5db22 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Test if two devices are the same <a class="el" href="classL4vbus_1_1Vbus.html" title="The virtual bus (Vbus) interface.">Vbus</a> device. <br /></td></tr>
|
|
<tr class="memitem:a9f5bce4e7220814a19abb0cdea611330 inherit pub_methods_classL4vbus_1_1Device" id="r_a9f5bce4e7220814a19abb0cdea611330"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Device.html#a9f5bce4e7220814a19abb0cdea611330">operator!=</a> (<a class="el" href="classL4vbus_1_1Device.html">Device</a> const &o) const</td></tr>
|
|
<tr class="memdesc:a9f5bce4e7220814a19abb0cdea611330 inherit pub_methods_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">Test if two <a class="el" href="classL4vbus_1_1Vbus.html" title="The virtual bus (Vbus) interface.">Vbus</a> devices are not the same. <br /></td></tr>
|
|
<tr class="inherit_header pub_methods_classL4vbus_1_1Pm"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classL4vbus_1_1Pm')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Public Member Functions inherited from <a class="el" href="classL4vbus_1_1Pm.html">L4vbus::Pm< Device ></a></td></tr>
|
|
<tr class="memitem:a3f6361841097aeed4f5eb44fafaaaa42 inherit pub_methods_classL4vbus_1_1Pm" id="r_a3f6361841097aeed4f5eb44fafaaaa42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Pm.html#a3f6361841097aeed4f5eb44fafaaaa42">pm_suspend</a> () const</td></tr>
|
|
<tr class="memdesc:a3f6361841097aeed4f5eb44fafaaaa42 inherit pub_methods_classL4vbus_1_1Pm"><td class="mdescLeft"> </td><td class="mdescRight">Suspend the device. <br /></td></tr>
|
|
<tr class="memitem:ada27de826a15347a7c49f061c9eb7d30 inherit pub_methods_classL4vbus_1_1Pm" id="r_ada27de826a15347a7c49f061c9eb7d30"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classL4vbus_1_1Pm.html#ada27de826a15347a7c49f061c9eb7d30">pm_resume</a> () const</td></tr>
|
|
<tr class="memdesc:ada27de826a15347a7c49f061c9eb7d30 inherit pub_methods_classL4vbus_1_1Pm"><td class="mdescLeft"> </td><td class="mdescRight">Resume the device. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-inherited" class="groupheader"><a id="inherited" name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_classL4vbus_1_1Device"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classL4vbus_1_1Device')"><span class="dynarrow"><span class="arrowhead closed"></span></span>Protected Attributes inherited from <a class="el" href="classL4vbus_1_1Device.html">L4vbus::Device</a></td></tr>
|
|
<tr class="memitem:acd6f6e54b1b83cd524781ba1bf69e504 inherit pro_attribs_classL4vbus_1_1Device" id="r_acd6f6e54b1b83cd524781ba1bf69e504"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="classL4_1_1Cap.html">L4::Cap</a>< <a class="el" href="classL4vbus_1_1Vbus.html">Vbus</a> > </td><td class="memItemRight" valign="bottom"><b>_bus</b></td></tr>
|
|
<tr class="memdesc:acd6f6e54b1b83cd524781ba1bf69e504 inherit pro_attribs_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classL4vbus_1_1Vbus.html" title="The virtual bus (Vbus) interface.">Vbus</a> capability where this device is located on. <br /></td></tr>
|
|
<tr class="memitem:ac055a07e37da8daa7b3a93cc833a6434 inherit pro_attribs_classL4vbus_1_1Device" id="r_ac055a07e37da8daa7b3a93cc833a6434"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="vbus__types_8h.html#a3d2ee122c9c592d768eee886d36b31cf">l4vbus_device_handle_t</a> </td><td class="memItemRight" valign="bottom"><b>_dev</b></td></tr>
|
|
<tr class="memdesc:ac055a07e37da8daa7b3a93cc833a6434 inherit pro_attribs_classL4vbus_1_1Device"><td class="mdescLeft"> </td><td class="mdescRight">The device handle for this device. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A <a class="el" href="classL4vbus_1_1Gpio__module.html" title="A Gpio_module groups multiple GPIO pins together.">Gpio_module</a> groups multiple GPIO pins together. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00133">133</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
|
|
<a id="a353f5c9e3e0c77b57308c0f2b21de582" name="a353f5c9e3e0c77b57308c0f2b21de582"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a353f5c9e3e0c77b57308c0f2b21de582">◆ </a></span>config_pad()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L4vbus::Gpio_module::config_pad </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &</td> <td class="paramname"><span class="paramname"><em>mask</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>func</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>value</em></span> ) const</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>Hardware specific configuration function for multiple GPIO pins. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mask</td><td>Mask of GPIO pins to configure. A bit set to 1 configures this pin. A maximum of 32 pins can be configured at once. The real number depends on the hardware and the driver implementation. </td></tr>
|
|
<tr><td class="paramname">func</td><td>Hardware specific configuration register, usually offset to the GPIO chip's base address. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Value which is written into the hardware specific configuration register for the specified pins </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, error code otherwise </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00185">185</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="vbus_source.html#l00245">L4vbus::Device::_bus</a>, <a class="el" href="vbus_source.html#l00247">L4vbus::Device::_dev</a>, and <a class="el" href="group__l4vbus__gpio__module.html#ga80b5e036a81eb7befb431996b40a707f">l4vbus_gpio_multi_config_pad()</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 call 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="classL4vbus_1_1Gpio__module_a353f5c9e3e0c77b57308c0f2b21de582_cgraph.svg" width="440" 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="a6a0d6e8e9f1c8e1e97a02770be4000a2" name="a6a0d6e8e9f1c8e1e97a02770be4000a2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6a0d6e8e9f1c8e1e97a02770be4000a2">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L4vbus::Gpio_module::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>offset</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>data</em></span> ) const</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>Read values of multiple GPIO pins at once. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">offset</td><td>Pin corresponding to the LSB in <em class="arg">data</em>. Note: allowed may be hardware specific. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">data</td><td>Each bit returns the value (0 or 1) for the corresponding GPIO pin. The value of pins that are not accessible is undefined. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, error code otherwise </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00201">201</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="vbus_source.html#l00245">L4vbus::Device::_bus</a>, <a class="el" href="vbus_source.html#l00247">L4vbus::Device::_dev</a>, and <a class="el" href="group__l4vbus__gpio__module.html#gab31b00f0bb6a783114f6d4c36320a063">l4vbus_gpio_multi_get()</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 call 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="classL4vbus_1_1Gpio__module_a6a0d6e8e9f1c8e1e97a02770be4000a2_cgraph.svg" width="419" 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="aa55ec464dec7cf14fd6edb7b3e1bc7eb" name="aa55ec464dec7cf14fd6edb7b3e1bc7eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa55ec464dec7cf14fd6edb7b3e1bc7eb">◆ </a></span>pin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classL4vbus_1_1Gpio__pin.html">Gpio_pin</a> L4vbus::Gpio_module::pin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>pin</em></span></td><td>)</td>
|
|
<td> const</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>Get <a class="el" href="classL4vbus_1_1Gpio__pin.html" title="A GPIO pin.">Gpio_pin</a> for a specific pin of this <a class="el" href="classL4vbus_1_1Gpio__module.html" title="A Gpio_module groups multiple GPIO pins together.">Gpio_module</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pin</td><td>GPIO pin number to get <a class="el" href="classL4vbus_1_1Gpio__pin.html" title="A GPIO pin.">Gpio_pin</a> for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classL4vbus_1_1Gpio__pin.html" title="A GPIO pin.">Gpio_pin</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00229">229</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="vbus__gpio_source.html#l00229">pin()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="vbus__gpio_source.html#l00229">pin()</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 call 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="classL4vbus_1_1Gpio__module_aa55ec464dec7cf14fd6edb7b3e1bc7eb_cgraph.svg" width="202" height="60"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<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="classL4vbus_1_1Gpio__module_aa55ec464dec7cf14fd6edb7b3e1bc7eb_icgraph.svg" width="202" height="60"><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="a8fc5645d80413e489f1f77da27f7c8c6" name="a8fc5645d80413e489f1f77da27f7c8c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fc5645d80413e489f1f77da27f7c8c6">◆ </a></span>set()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L4vbus::Gpio_module::set </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &</td> <td class="paramname"><span class="paramname"><em>mask</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</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>Set multiple GPIO output pins at once. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mask</td><td>Mask of GPIO pins to set. A bit set to 1 selects this pin. A maximum of 32 pins can be set at once. The real number depends on the hardware and the driver implementation. </td></tr>
|
|
<tr><td class="paramname">data</td><td>Each bit corresponds to the GPIO pin in <em class="arg">mask</em>. The value of each bit is written to the GPIO pin if its bit in <em class="arg">mask</em> is set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, error code otherwise </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00217">217</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="vbus_source.html#l00245">L4vbus::Device::_bus</a>, <a class="el" href="vbus_source.html#l00247">L4vbus::Device::_dev</a>, and <a class="el" href="group__l4vbus__gpio__module.html#ga257c6a6144968e79483b7c6994113bfc">l4vbus_gpio_multi_set()</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 call 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="classL4vbus_1_1Gpio__module_a8fc5645d80413e489f1f77da27f7c8c6_cgraph.svg" width="418" 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="a05cbf73e4df7cc4fd4f32b2a47513bcf" name="a05cbf73e4df7cc4fd4f32b2a47513bcf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a05cbf73e4df7cc4fd4f32b2a47513bcf">◆ </a></span>setup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int L4vbus::Gpio_module::setup </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structL4vbus_1_1Gpio__module_1_1Pin__slice.html">Pin_slice</a> const &</td> <td class="paramname"><span class="paramname"><em>mask</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>mode</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>value</em></span> ) const</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>Configure function of multiple GPIO pins at once. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mask</td><td>Mask of GPIO pins to configure. A bit set to 1 configures this pin. A maximum of 32 pins can be configured at once. The real number depends on the hardware and the driver implementation. </td></tr>
|
|
<tr><td class="paramname">mode</td><td>GPIO function, see <a class="el" href="group__l4vbus__gpio__module.html#ga18772c955709cc686b52d0a528e192aa" title="Constants for generic GPIO functions.">L4vbus_gpio_generic_func</a> for generic functions. Hardware specific functions must be provided in the lower 8 bits. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Optional value to set the GPIO pins to if they are configured as output pins </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, error code otherwise </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vbus__gpio_source.html#l00166">166</a> of file <a class="el" href="vbus__gpio_source.html">vbus_gpio</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="vbus_source.html#l00245">L4vbus::Device::_bus</a>, <a class="el" href="vbus_source.html#l00247">L4vbus::Device::_dev</a>, and <a class="el" href="group__l4vbus__gpio__module.html#gaa66a84f04240f0efad6b04538b6bae9c">l4vbus_gpio_multi_setup()</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 call 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="classL4vbus_1_1Gpio__module_a05cbf73e4df7cc4fd4f32b2a47513bcf_cgraph.svg" width="406" 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>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>l4/vbus/<a class="el" href="vbus__gpio_source.html">vbus_gpio</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="namespaceL4vbus.html">L4vbus</a></li><li class="navelem"><a href="classL4vbus_1_1Gpio__module.html">Gpio_module</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>
|