specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
USB_Host_Shield_2.0/class_address_pool.html
Kristian Sloth Lauszus 9b34049782 Updated the documentation
2018-10-13 15:47:19 +02:00

209 lines
9.4 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>USB Host Shield 2.0: AddressPool 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="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="imageStyle.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_address_pool-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AddressPool Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="address_8h_source.html">address.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AddressPool:</div>
<div class="dyncontent">
<div class="center"><img src="class_address_pool__inherit__graph.png" border="0" usemap="#_address_pool_inherit__map" alt="Inheritance graph"/></div>
<map name="_address_pool_inherit__map" id="_address_pool_inherit__map">
<area shape="rect" id="node2" href="class_address_pool_impl.html" title="AddressPoolImpl\&lt; MAX\l_DEVICES_ALLOWED \&gt;" alt="" coords="5,79,177,117"/>
<area shape="rect" id="node3" href="class_address_pool_impl.html" title="AddressPoolImpl\&lt; USB\l_NUMDEVICES \&gt;" alt="" coords="201,79,362,117"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa92d7e8f0f515340ae2dc1679b627056"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="struct_usb_device.html">UsbDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_address_pool.html#aa92d7e8f0f515340ae2dc1679b627056">GetUsbDevicePtr</a> (uint8_t addr)=0</td></tr>
<tr class="separator:aa92d7e8f0f515340ae2dc1679b627056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97df4ef42e50960ce2165f4cdb53e590"><td class="memItemLeft" align="right" valign="top">virtual uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_address_pool.html#a97df4ef42e50960ce2165f4cdb53e590">AllocAddress</a> (uint8_t parent, bool is_hub=false, uint8_t port=0)=0</td></tr>
<tr class="separator:a97df4ef42e50960ce2165f4cdb53e590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15fde13223dcb1da89305ad229763562"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_address_pool.html#a15fde13223dcb1da89305ad229763562">FreeAddress</a> (uint8_t addr)=0</td></tr>
<tr class="separator:a15fde13223dcb1da89305ad229763562"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="address_8h_source.html#l00090">90</a> of file <a class="el" href="address_8h_source.html">address.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa92d7e8f0f515340ae2dc1679b627056"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa92d7e8f0f515340ae2dc1679b627056">&#9670;&nbsp;</a></span>GetUsbDevicePtr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="struct_usb_device.html">UsbDevice</a>* AddressPool::GetUsbDevicePtr </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_address_pool_impl.html#aa3e12dda249ef6acbb27592fc8fe1cba">AddressPoolImpl&lt; MAX_DEVICES_ALLOWED &gt;</a>, and <a class="el" href="class_address_pool_impl.html#aa3e12dda249ef6acbb27592fc8fe1cba">AddressPoolImpl&lt; USB_NUMDEVICES &gt;</a>.</p>
</div>
</div>
<a id="a97df4ef42e50960ce2165f4cdb53e590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97df4ef42e50960ce2165f4cdb53e590">&#9670;&nbsp;</a></span>AllocAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint8_t AddressPool::AllocAddress </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_hub</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>port</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_address_pool_impl.html#a14657183c73c631754b31bd0cc588c87">AddressPoolImpl&lt; MAX_DEVICES_ALLOWED &gt;</a>, and <a class="el" href="class_address_pool_impl.html#a14657183c73c631754b31bd0cc588c87">AddressPoolImpl&lt; USB_NUMDEVICES &gt;</a>.</p>
</div>
</div>
<a id="a15fde13223dcb1da89305ad229763562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15fde13223dcb1da89305ad229763562">&#9670;&nbsp;</a></span>FreeAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void AddressPool::FreeAddress </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_address_pool_impl.html#a3d59841faa336c359b0736ca45988ce5">AddressPoolImpl&lt; MAX_DEVICES_ALLOWED &gt;</a>, and <a class="el" href="class_address_pool_impl.html#a3d59841faa336c359b0736ca45988ce5">AddressPoolImpl&lt; USB_NUMDEVICES &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="address_8h_source.html">address.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink