USB_Host_Shield_2.0/address_8h_source.html

129 lines
59 KiB
HTML
Raw Normal View History

2013-01-30 22:00:18 +01:00
<!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"/>
2016-04-19 18:16:46 +02:00
<meta name="generator" content="Doxygen 1.8.11"/>
<title>USB Host Shield 2.0: address.h Source File</title>
2013-01-30 22:00:18 +01:00
<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"/>
2015-04-07 16:07:33 +02:00
<script type="text/javascript" src="search/searchdata.js"></script>
2013-01-30 22:00:18 +01:00
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
2015-04-07 16:07:33 +02:00
$(document).ready(function() { init_search(); });
2013-01-30 22:00:18 +01:00
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="imageStyle.css" rel="stylesheet" type="text/css"/>
2013-01-30 22:00:18 +01:00
</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;">
2016-04-19 18:16:46 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">USB Host Shield 2.0
2013-01-30 22:00:18 +01:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2016-04-19 18:16:46 +02:00
<!-- Generated by Doxygen 1.8.11 -->
2013-01-30 22:00:18 +01:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2015-04-07 16:07:33 +02:00
</div>
2013-01-30 22:00:18 +01:00
<!-- 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 id="nav-path" class="navpath">
<ul>
2016-04-19 18:16:46 +02:00
<li class="navelem"><a class="el" href="dir_69161428018e52ad84691a5947f27cc9.html">Github</a></li><li class="navelem"><a class="el" href="dir_ee762931928e29ae94e054d18c99dc9e.html">USB_Host_Shield_2_0</a></li> </ul>
2013-01-30 22:00:18 +01:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">address.h</div> </div>
</div><!--header-->
<div class="contents">
2016-04-19 18:16:46 +02:00
<a href="address_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">This software may be distributed and modified under the terms of the GNU</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">General Public License version 2 (GPL2) as published by the Free Software</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">Foundation and appearing in the file GPL2.TXT included in the packaging of</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">this file. Please note that GPL2 Section 2[b] requires that all works based</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">on this software must also be made publicly available under the terms of</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">the GPL2 (&quot;Copyleft&quot;).</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Contact information</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">-------------------</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">Circuits At Home, LTD</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">Web : http://www.circuitsathome.com</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">e-mail : support@circuitsathome.com</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if !defined(_usb_h_) || defined(__ADDRESS_H__)</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#error &quot;Never include address.h directly; include Usb.h instead&quot;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define __ADDRESS_H__</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">/* NAK powers. To save space in endpoint data structure, amount of retries before giving up and returning 0x4 is stored in */</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/* bmNakPower as a power of 2. The actual nak_limit is then calculated as nak_limit = ( 2^bmNakPower - 1) */</span></div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="address_8h.html#a517dfa014946e2d087d197312234a1de"> 27</a></span>&#160;<span class="preprocessor
2013-10-21 21:15:43 +02:00
<div class="ttc" id="class_address_pool_html"><div class="ttname"><a href="class_address_pool.html">AddressPool</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00083">address.h:83</a></div></div>
<div class="ttc" id="struct_usb_device_html_a410d39fb7758157f57794335e990ed02"><div class="ttname"><a href="struct_usb_device.html#a410d39fb7758157f57794335e990ed02">UsbDevice::epinfo</a></div><div class="ttdeci">EpInfo * epinfo</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00076">address.h:76</a></div></div>
<div class="ttc" id="struct_usb_device_html_a86a815577ad7883437d3ca72b32b8e8a"><div class="ttname"><a href="struct_usb_device.html#a86a815577ad7883437d3ca72b32b8e8a">UsbDevice::lowspeed</a></div><div class="ttdeci">bool lowspeed</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00079">address.h:79</a></div></div>
<div class="ttc" id="struct_ep_info_html_a3a5b1c017a034cd9e06e76729e727c46"><div class="ttname"><a href="struct_ep_info.html#a3a5b1c017a034cd9e06e76729e727c46">EpInfo::bmNakPower</a></div><div class="ttdeci">uint8_t bmNakPower</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00042">address.h:42</a></div></div>
<div class="ttc" id="struct_usb_device_html"><div class="ttname"><a href="struct_usb_device.html">UsbDevice</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00075">address.h:75</a></div></div>
2014-01-10 18:20:37 +01:00
<div class="ttc" id="class_address_pool_impl_html_aeaf73d809ebb97bb1015789b8dc31ffa"><div class="ttname"><a href="class_address_pool_impl.html#aeaf73d809ebb97bb1015789b8dc31ffa">AddressPoolImpl::AddressPoolImpl</a></div><div class="ttdeci">AddressPoolImpl()</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00164">address.h:164</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="struct_usb_device_address_html_a28e8292497f782fbe83f97ac70eb0aef"><div class="ttname"><a href="struct_usb_device_address.html#a28e8292497f782fbe83f97ac70eb0aef">UsbDeviceAddress::bmReserved</a></div><div class="ttdeci">uint8_t bmReserved</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00065">address.h:65</a></div></div>
<div class="ttc" id="struct_ep_info_html_a1dea928517c961235eef7b0876e69f10"><div class="ttname"><a href="struct_ep_info.html#a1dea928517c961235eef7b0876e69f10">EpInfo::epAttribs</a></div><div class="ttdeci">uint8_t epAttribs</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00037">address.h:37</a></div></div>
<div class="ttc" id="struct_ep_info_html_a9f92be74c75c037b39e2cae1eb49b89b"><div class="ttname"><a href="struct_ep_info.html#a9f92be74c75c037b39e2cae1eb49b89b">EpInfo::epAddr</a></div><div class="ttdeci">uint8_t epAddr</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00033">address.h:33</a></div></div>
<div class="ttc" id="address_8h_html_a517dfa014946e2d087d197312234a1de"><div class="ttname"><a href="address_8h.html#a517dfa014946e2d087d197312234a1de">USB_NAK_MAX_POWER</a></div><div class="ttdeci">#define USB_NAK_MAX_POWER</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00027">address.h:27</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_address_pool_impl_html_aa3e12dda249ef6acbb27592fc8fe1cba"><div class="ttname"><a href="class_address_pool_impl.html#aa3e12dda249ef6acbb27592fc8fe1cba">AddressPoolImpl::GetUsbDevicePtr</a></div><div class="ttdeci">virtual UsbDevice * GetUsbDevicePtr(uint8_t addr)</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00181">address.h:181</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="struct_ep_info_html"><div class="ttname"><a href="struct_ep_info.html">EpInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00032">address.h:32</a></div></div>
<div class="ttc" id="struct_ep_info_html_ac85bff70ad0e5d71e50cb501f4d8caf3"><div class="ttname"><a href="struct_ep_info.html#ac85bff70ad0e5d71e50cb501f4d8caf3">EpInfo::bmSndToggle</a></div><div class="ttdeci">uint8_t bmSndToggle</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00040">address.h:40</a></div></div>
<div class="ttc" id="struct_usb_device_address_html_a79ed442d6a357907ddb4d1697bd6af5f"><div class="ttname"><a href="struct_usb_device_address.html#a79ed442d6a357907ddb4d1697bd6af5f">UsbDeviceAddress::devAddress</a></div><div class="ttdeci">uint8_t devAddress</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00067">address.h:67</a></div></div>
<div class="ttc" id="struct_usb_device_address_html_ae12b0ac1b76a34d0a5080cc62f41c622"><div class="ttname"><a href="struct_usb_device_address.html#ae12b0ac1b76a34d0a5080cc62f41c622">UsbDeviceAddress::bmAddress</a></div><div class="ttdeci">uint8_t bmAddress</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00062">address.h:62</a></div></div>
<div class="ttc" id="struct_usb_device_address_html_abd628d37834249af6518f320f3f19065"><div class="ttname"><a href="struct_usb_device_address.html#abd628d37834249af6518f320f3f19065">UsbDeviceAddress::bmParent</a></div><div class="ttdeci">uint8_t bmParent</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00063">address.h:63</a></div></div>
<div class="ttc" id="class_address_pool_impl_html"><div class="ttname"><a href="class_address_pool_impl.html">AddressPoolImpl</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00096">address.h:96</a></div></div>
<div class="ttc" id="struct_usb_device_html_a828814f5231b866ac665a24ec5edaa3a"><div class="ttname"><a href="struct_usb_device.html#a828814f5231b866ac665a24ec5edaa3a">UsbDevice::epcount</a></div><div class="ttdeci">uint8_t epcount</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00078">address.h:78</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_address_pool_impl_html_a09e6dc797f82543eba0879369116182e"><div class="ttname"><a href="class_address_pool_impl.html#a09e6dc797f82543eba0879369116182e">AddressPoolImpl::ForEachUsbDevice</a></div><div class="ttdeci">void ForEachUsbDevice(UsbDeviceHandleFunc pfunc)</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00192">address.h:192</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="struct_ep_info_html_aa2ca775b63736df4008e88da7dd4dddb"><div class="ttname"><a href="struct_ep_info.html#aa2ca775b63736df4008e88da7dd4dddb">EpInfo::maxPktSize</a></div><div class="ttdeci">uint8_t maxPktSize</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00034">address.h:34</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_address_pool_impl_html_a3d59841faa336c359b0736ca45988ce5"><div class="ttname"><a href="class_address_pool_impl.html#a3d59841faa336c359b0736ca45988ce5">AddressPoolImpl::FreeAddress</a></div><div class="ttdeci">virtual void FreeAddress(uint8_t addr)</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00255">address.h:255</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="struct_usb_device_address_html"><div class="ttname"><a href="struct_usb_device_address.html">UsbDeviceAddress</a></div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00057">address.h:57</a></div></div>
2016-04-19 18:16:46 +02:00
<div class="ttc" id="class_address_pool_impl_html_a14657183c73c631754b31bd0cc588c87"><div class="ttname"><a href="class_address_pool_impl.html#a14657183c73c631754b31bd0cc588c87">AddressPoolImpl::AllocAddress</a></div><div class="ttdeci">virtual uint8_t AllocAddress(uint8_t parent, bool is_hub=false, uint8_t port=0)</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00203">address.h:203</a></div></div>
2014-01-10 18:20:37 +01:00
<div class="ttc" id="struct_usb_device_html_a351d1099501c36d9f301495acefd5f99"><div class="ttname"><a href="struct_usb_device.html#a351d1099501c36d9f301495acefd5f99">UsbDevice::address</a></div><div class="ttdeci">UsbDeviceAddress address</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00077">address.h:77</a></div></div>
2013-10-21 21:15:43 +02:00
<div class="ttc" id="struct_usb_device_address_html_a0a8f124a7e7a2ba116e70c2fbf0c551e"><div class="ttname"><a href="struct_usb_device_address.html#a0a8f124a7e7a2ba116e70c2fbf0c551e">UsbDeviceAddress::bmHub</a></div><div class="ttdeci">uint8_t bmHub</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00064">address.h:64</a></div></div>
2015-04-07 16:07:33 +02:00
<div class="ttc" id="address_8h_html_ae95131d8d03796566b00a312faa8360a"><div class="ttname"><a href="address_8h.html#ae95131d8d03796566b00a312faa8360a">UsbDeviceHandleFunc</a></div><div class="ttdeci">void(* UsbDeviceHandleFunc)(UsbDevice *pdev)</div><div class="ttdef"><b>Definition:</b> <a href="address_8h_source.html#l00090">address.h:90</a></div></div>
2013-01-30 22:00:18 +01:00
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
2013-01-30 22:00:18 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
2016-04-19 18:16:46 +02:00
</a> 1.8.11
2013-01-30 22:00:18 +01:00
</small></address>
</body>
</html>